Savings Plan Upcoming Trade v2

Webhook

POST

savings-plan-notice-v2

The webhook is used to alert partners about the upcoming execution of a trade related to a Savings Plan, allowing them to prepare and reserve the funds.

Request

Body Params application/json

Examples

Responses

🟢200

Return a 200, 201, 202 or 204 status to indicate that the data was received successfully

This response does not have a body.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "params": {
        "savings_plan_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
        "external_transaction_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
        "user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
        "fiat_id": "4fbc982a-d8f3-431a-8f14-3ed5d8f23312",
        "asset_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
        "fiat_amount": "20.12",
        "savings_plan_frequency": "weekly",
        "savings_plan_day": 5,
        "savings_plan_next_recurrence": "2023-01-06T12:00:00Z",
        "savings_plan_transaction_confirmation_deadline": "2023-01-06T12:00:00Z",
        "savings_plan_status": "active",
        "savings_plan_created_at": "2022-01-01T13:07:31+00Z"
    }
}'

Savings Plan Upcoming Trade

Savings Plan Successful Trade