Skip to main content

Create a payout originator

Required scopes:

  • partner.payout-originator.create
Request Body — REQUIRED
dateOfBirth date

Date of birth of the individual.

type string — REQUIRED

Possible values: [INDIVIDUAL, COMPANY]

Type of the originator.

name string — REQUIRED

Originator's name.

address object — REQUIRED

Originator's address.

country string — REQUIRED

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

state string

State code based on the country.

city string — REQUIRED

The name of the city or town.

postCode string — REQUIRED

The postal code or ZIP code for the address.

line1 string — REQUIRED

The street address.

Responses
201

Created

Schema — OPTIONAL
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.