Create a savings plan V2

POST

/v2/savings-plan

The endpoint enables users to set up a customised savings plan by specifying a portion of their income to be regularly saved (weekly, biweekly or monthly), with the aim of achieving a designated financial goal.
It returns details of the created plan including next recurrence date and the date when the partner will be notified about the upcoming savings plan trade execution.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Success Response (Subsequent Idempotent Request).

Body

🟢201

🟠400

🟠401

🟠403

🟠404

🟠405

🟠409

🟠422

🔴500

🔴503

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test.whitelabel.bitpanda.com/v2/savings-plan' \
--header 'bp-user-id;' \
--header 'idempotency-key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
    "fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
    "amount": "20.11",
    "frequency": "weekly",
    "day": 5,
    "external_tx_id": "c04cd877-cb9c-485c-bbc8-6bec3eb41b39"
}'

Response Example

200 - Example 1

{
    "data": {
        "user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
        "fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
        "asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
        "fiat_amount": "20.12",
        "frequency": "weekly",
        "day": 5,
        "next_recurrence": "2023-01-06T12:00:00+00:00",
        "notification_date": "2023-01-04",
        "status": "active",
        "id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
        "created_at": "2022-01-01T13:07:31+00:00"
    }
}

Confirm a savings plan transaction V2

Search for savings plans V2