DIdintero
payout-destinations

aid_mgmnt_payout_destinations_get

Get list of payout destinations

scopes:

  • admin:accounts
  • read:accounts
get/accounts/{oid}/payout-destinations

Request

Path parameters

oidstring ^[PT]{1}(?=(?:.{3}|.{8})$)[0-9]*$ required

An id that uniquely identifies the account or owner (partner)

Query parameters

starting_afterstring

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

searchstring

Search payout destinations by organisation details, payout_destination_id, id.

case_statusstring[]

Filter by case status

countrystring[]

Search payout destinations by country

store_idstring[]

Search payout destinations by associated store ids

terminal_idstring[]

Search payout destinations by associated terminal ids

Response

List of payout destinations

starting_afterstring

Example response

{
  "payout_destinations": [
    {
      "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
      "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
      "payout_destination_id": "PD032",
      "merchant_category_code": "2741",
      "individual": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "address_postal_code": "0349",
        "address_city": "Oslo",
        "address_country": "NO"
      },
      "address": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO"
      },
      "bank_accounts": [
        {
          "bank_account_country_code": "NO",
          "bank_account_currency": "NOK",
          "bank_identification_code": "DNBANOKKXXX"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.