Reference Accounts

Download Spec

All reference account related paths

Get reference accounts of a user
get /users/{user_id}/payments/reference_accounts

Returns the list of reference accounts of a user specified by ID.

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

OK

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1
  },
  "data": [
    {
      "id": "c18f80bd-401e-4836-9776-7dc24c32d35e",
      "created_at": "2020-08-24T14:15:22Z",
      "updated_at": "2020-08-24T14:15:22Z",
      "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "account_owner": "Max Mustermann",
      "name": "Max's Reference Account",
      "iban": "DE0210**********0402",
      "bic": "BELADEBE",
      "confirmed_at": "2020-08-23T14:15:22Z"
    }
  ]
}

Create a reference account
post /payments/reference_accounts

Creates a new reference account for a user specified by ID.

user_id

string

uuid

User unique identifier.

account_owner

string

required

First and last name of the reference account owner

Max Length
140

name

string

Human-readable name of the reference bank account

Max Length
100

iban

string

^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$

required

International Bank Account Number IBAN.

bic

string

^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

confirmed_at

string

date-time

required

Timestamp of when user validated the reference account

Request

{
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "account_owner": "Max Mustermann",
  "name": "Max's Reference Account",
  "iban": "DE02100500000054540402",
  "bic": "BELADEBE",
  "confirmed_at": "2020-08-23T14:15:22Z"
}

Response

ExamplesSchema

Reference account created.

{
  "id": "c18f80bd-401e-4836-9776-7dc24c32d35e",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "account_owner": "Max Mustermann",
  "name": "Max's Reference Account",
  "iban": "DE0210**********0402",
  "bic": "BELADEBE",
  "confirmed_at": "2020-08-23T14:15:22Z"
}

Get a reference account by ID
get /payments/reference_accounts/{reference_account_id}

Retrieves the reference account specified by its ID.

reference_account_id

string

uuid

required

Reference account unique identifier.

Response

ExamplesSchema

OK

{
  "id": "c18f80bd-401e-4836-9776-7dc24c32d35e",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "account_owner": "Max Mustermann",
  "name": "Max's Reference Account",
  "iban": "DE0210**********0402",
  "bic": "BELADEBE",
  "confirmed_at": "2020-08-23T14:15:22Z"
}

Delete a reference account by ID
delete /payments/reference_accounts/{reference_account_id}

Deletes the reference account specified by its ID.

reference_account_id

string

uuid

required

Reference account unique identifier.

Response

ExamplesSchema

Request has been processed successfully.

Empty response

Was this page helpful?