Skip to main content

Search Payout Account

The endpoint and http method information to search payout account are stated below.

URL

The endpoint and http method information to search payout account are stated below.

GET/settlement/v1/payout-accounts

Request Parameters

The parameters expected to be sent in requests to search payout account are listed under the table and subheadings below.

currency
Currency
required

See: Currencies Payout Account Currency

Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
KWD
SAR
BHD
RUB
JPY
EGP
accountOwner
PayoutAccountOwner
required

Account Owner

Values:
MERCHANT
SUB_MERCHANT_MEMBER
subMerchantMemberId
number

Sub merchant member id is necessary if account owner is sub merchant

page
number

Page number

size
number

Record size in one page

Response Parameters

Parameters returned as a result of search payout account are also subject to the rules specified in the Response Formats section of the API documentation home page. In the absence of a systematic or fictional error, the sub-parameters of the object returned in the data parameter are as follows:

id
number

Payout Account ID

type
PayoutAccountType

Account Type

Values:
WISE
externalAccountId
string

External Account Id

currency
Currency

See: Currencies Payout Account Currency

Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
KWD
SAR
BHD
RUB
JPY
EGP
accountOwner
PayoutAccountOwner

Account Owner

Values:
MERCHANT
SUB_MERCHANT_MEMBER
subMerchantMemberId
number

Sub merchant member id is necessary if account owner is sub merchant

Sample Codes

You can review the sample codes in the open source Craftgate API clients.

Loading..