Create a savings plan V2

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.

SecuritybearerAuth
Request
header Parameters
bp-user-id
required
string <uuid>
idempotency-key
required
string <uuid>

A unique identifier for the create savings plan request. Guarantees that only one resource will be created regardless of how many times a request is sent to us.

Example: 2e4c89ac-1290-426f-8de0-4c7b40b91d3a
Request Body schema: application/json

Create savings plan details.

asset_id
required
string <uuid>

Asset ID that needs to be bought when savings plan trade will be executed.

fiat_id
required
string <uuid>

The fiat ID of the savings plan / Currency of the savings plan.

amount
required
number <string> [ 10 .. 10000 ]

The amount of the savings plan.

frequency
required
string

The frequency of the savings plan (weekly, biweekly, monthly).

Enum: "weekly" "biweekly" "monthly"
day
required
integer [ 1 .. 31 ]

Day of the savings plan execution. For a weekly & biweekly frequency, it's accepted only a value between 1...7 where 1 = Monday...7 = Sunday. For a monthly frequency it's accepted only a value between 1...31.

external_tx_id
string or null <uuid>

An optional external transaction identifier provided by partners. It serves as a unique reference to link the partner’s savings plan ID with the Bitpanda savings plan ID. This field is not exposed in API responses but may be required in internal reports or reconciliation processes.

Responses
200

Success Response (Subsequent Idempotent Request).

201

Success Response (Created)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Not Allowed

409

Conflict

422

Validation Error

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

post/v2/savings-plan
Request samples
application/json
{
  • "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 samples
application/json
{
  • "data": {
    }
}