List Payout Accounts

GET 
/payout_accounts

List Payout Accounts

Request

Query Parameters

page int32

Default value: 1

Page to list

Responses

200

Successful operation

application/json

Schema

Schema

payout_accounts

object[]required

Array [

id uuidrequired

The ID of the payout account.

account_type AccountType (string)required

Possible values: [bank, wallet]

Indicates the payout account type.

currency Currency (string)required

ISO-4217 three-letter currency code.

properties objectrequired

Contains the public information relevant to the payout account. For example, the IBAN of the bank account. Every service provider can provide a different set of properties.

created_at timestamprequired

Date and time when the payout account was created.

]

metaobjectrequired
current_page integer
next_page integer
prev_page integer
total_pages integer
total_count integer

Example (from schema)

{
  "payout_accounts": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "account_type": "bank",
      "currency": "SAR",
      "properties": {
        "iban": "SA8430400108057386290038"
      },
      "created_at": "Date and time when the payout account was created."
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

Loading...