Create a push-to-card recipient

post

https://api.stage.payouts.com/api/v1/push-to-card/recipients

Required headers for authentication with api key OR more secure signature + timestamp

Required permissions for this API:

and: CREATE:TRANSFERS

or:

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accountType

string

enum

required

The legal entity of the card account

Allowed:

firstName

string

required

First name (required, max 64 characters)

lastName

string

required

Last name (required, max 64 characters)

string

required

Email address (required, max 64 characters)

nickName

string

Nickname (optional, max 64 characters)

phoneNumber

string

Phone number (optional, max 16 characters)

cardNumber

string

required

Card number (will be encrypted, only last 4 digits stored)

expirationDate

string

required

Card expiration date in YYYY-MM format (cannot be in the past)

currency

string

required

Defaults to USD

Currency (only USD available for Push to Card)

street

string

Street address (optional)

city

string

City (optional)

state

string

State (optional)

country

string

required

Country code (required, must be from supported countries list)

postalCode

string

ZIP/Postal code (optional, format validated based on country)

Responses

401

Invalid API Key

500

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200