All payments related paths

List direct debits

get /account_groups/{account_group_id}/payments/direct_debits

List direct debits

sort

string

Field of resource to sort by

Default
"created_at"
Enum
  • id
  • created_at
Example
"id"

order

string

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

Response

ExamplesSchema

Direct debits list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
      "created_at": "2020-08-24T14:15:22Z",
      "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
      "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
      "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
      "cash_amount": "200.00",
      "currency": "EUR",
      "remittance_information": "payment for green energy portfolio",
      "status": "NEW"
    }
  ]
}

Trigger a direct debit

post /payments/direct_debits

Trigger a direct debit

user_id

string

uuid

required

User unique identifier.

account_group_id

string

uuid

required

Account group unique identifier.

mandate_id

string

uuid

required

Direct Debit Mandate unique identifier.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

required

remittance_information

string

^[0-9A-Za-z+?/\-:()\.,'; ]{0,140}$

Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”)

Max Length
140

Response

ExamplesSchema

Direct debit

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "NEW"
}

Retrieve a direct debit

get /payments/direct_debits/{direct_debit_id}

Retrieve a direct debit

direct_debit_id

string

uuid

required

Direct debit funding request unique identifier

Response

ExamplesSchema

Direct debit payment

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
  "cash_amount": "200.00",
  "currency": "EUR",
  "remittance_information": "payment for green energy portfolio",
  "status": "NEW"
}

List top-ups

get /account_groups/{account_group_id}/payments/topups

Returns a list of top-ups.

sort

string

Field of resource to sort by

Default
"created_at"
Enum
  • id
  • created_at
Example
"id"

order

string

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

Response

ExamplesSchema

List of top-ups.

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
      "created_at": "2020-08-24T14:15:22Z",
      "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
      "cash_amount": "200.00",
      "currency": "EUR",
      "status": "CONFIRMED"
    }
  ]
}

Create a top-up

post /payments/topups

Triggers the creation of a top-up payment.

account_group_id

string

uuid

required

Account group unique identifier.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

required

currency

string

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

Response

ExamplesSchema

Top-up created.

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "CONFIRMED",
  "settlement_reference": "1ab4fef9-a097-4c6f-9345-647025d5fde6"
}

Get a top-up by ID

get /payments/topups/{topup_id}

Returns a top-up specified by its ID.

topup_id

string

uuid

required

Top up request unique identifier.

Response

ExamplesSchema

OK.

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "CONFIRMED"
}

Trigger a withdrawal

post /payments/withdrawals

Trigger a withdrawal

reference_account_id

string

uuid

required

Reference account unique identifier.

account_group_id

string

uuid

required

Account group unique identifier.

user_id

string

uuid

required

User unique identifier.

amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

required

remittance_information

string

^[0-9A-Za-z+?/\-:()\.,'; ]{0,140}$

Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”)

Max Length
140

Response

ExamplesSchema

Withdrawal

{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
  "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
  "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7",
  "amount": "200.00",
  "currency": "EUR",
  "remittance_information": "Withdrawal",
  "status": "NEW"
}

Retrieve withdrawal

get /payments/withdrawals/{withdrawal_id}

Retrieve withdrawal

withdrawal_id

string

uuid

required

Cash withdrawal unique identifier

Response

ExamplesSchema

Withdrawal

{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
  "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
  "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7",
  "amount": "200.00",
  "currency": "EUR",
  "remittance_information": "Withdrawal",
  "status": "CONFIRMED"
}

Cancel withdrawal by ID

delete /payments/withdrawals/{withdrawal_id}

Cancels a withdrawal specified by its ID. It is only possible to cancel a withdrawal if it has the status NEW.

withdrawal_id

string

uuid

required

Cash withdrawal unique identifier

Response

ExamplesSchema

Request has been processed successfully.

Empty response

List withdrawals

get /account_groups/{account_group_id}/payments/withdrawals

List withdrawals

sort

string

Field of resource to sort by

Default
"created_at"
Enum
  • id
  • created_at
Example
"id"

order

string

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

Response

ExamplesSchema

Withdrawals list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1
  },
  "data": [
    {
      "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
      "created_at": "2020-08-