Fetch saved merchant customer payout recipient list V3

Fetch merchant customer saved payout recipient list of all recipients belonging to the merchant customer.

Request

Path Params

merchantCustomerId

string

required

An unique merchant customer external identifier

>= 1 characters<= 128 characters

Query Params

phoneNumber

string

required

Phone number

>= 2 characters<= 64 characters

Example:

48664778234

Match pattern:

^[0-9\+]+$

currency

string

required

Currency

>= 3 characters<= 3 characters

Example:

PLN

Match pattern:

^[A-Z]+$

amount

string

required

Amount

Example:

123.04

Match pattern:

^(?=.*[0-9])\d{1,16}(?:\.\d{1,12})?$

itemsPerPage

string

optional

Limit of results

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Page of results

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Direction of order

Allowed values:

ascdesc

Default:

desc

sortBy

enum<string>

optional

column sorting

Allowed values:

createdAtlastUsedAt

Default:

lastUsedAt

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

customer-ip

required

A customer IP address for feature use

Any of

string<ipv4>

string<ipv6>

<= 15 characters

Example:

127.0.0.1

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

data

array[object (CustomerPayoutRecipientOutputV3) {13}]

required

string <uuid>

required

merchantCustomerId

string

required

alias

string

optional

active

boolean

required

last4

string

required

lastUsedAt

string

optional

lastUsedCurrency

string

optional

organization

string

required

paymentMethod

string

required

paymentChannel

string

required

channelLogoUrl

string

optional

organizationLogoUrl

string

optional

createdAt

string

required

meta

object

PayoutRecipientsMeta

required

itemsPerPage

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Allowed values:

ascdesc

Default:

asc

sortBy

enum<string>

optional

Allowed values:

createdAtlastUsedAt

Default:

lastUsedAt

totalCount

string

optional

Example:

Example

{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "merchantCustomerId": "string",
            "alias": "string",
            "active": true,
            "last4": "string",
            "lastUsedAt": "string",
            "lastUsedCurrency": "string",
            "organization": "string",
            "paymentMethod": "string",
            "paymentChannel": "string",
            "channelLogoUrl": "string",
            "organizationLogoUrl": "string",
            "createdAt": "string"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "lastUsedAt",
        "totalCount": "0"
    }
}

🟠404Record Not Found