Skip to main content

Get payout originators

Required scopes:

  • partner.payout-originator.read
Query Parameters
$skip int32

Skip the specified number of entries

$top int32

Possible values: value ≤ 100

Get the top X number of records. Max value: 100

Responses
200

OK

Schema OPTIONAL
items object[]

The page items.

id uuid

Id of the originator.

state string

Possible values: [PENDING_REVIEW, APPROVED, REJECTED, INACTIVE]

State of the originator.

created date-time

Time at which originator has been created.

details object

Details about the originator.

dateOfBirth date OPTIONAL

Date of birth of the individual.

type string

Possible values: [INDIVIDUAL, COMPANY]

Type of the originator.

name string

Originator's name.

address object

Originator's address.

country string

ISO 3166-1 alpha-2 code for the country.

state string OPTIONAL

State code based on the country.

city string

The name of the city or town.

postCode string

The postal code or ZIP code for the address.

line1 string

The street address.

count int64

Total number of records.