Create a new reloadable card transfer

post

https://api.stage.payouts.com/api/v1/reloadable/transfers

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requestId

string

required

Idempotency key. Must be unique per request attempt. Must be a valid UUID.

paymentDate

string | null

required

Date when the transfer should be done

currency

string

required

Currency you would like to pay in

amount

number

required

Amount you would like have on the card

reason

string

Reason

reference

string

External reference visible to end users for customer service and reconciliation. Max 64 characters

internalReference

string

Internal reference for client system tracking, audit trails, and internal reconciliation. Max 16 characters

recipientFirstName

string

required

First name of the recipient. Required when action is CREATE or when reloadableCardId is not provided

recipientLastName

string

required

Last name of the recipient. Required when action is CREATE or when reloadableCardId is not provided

recipientEmail

string

required

Email address of the recipient. Required when action is CREATE or when reloadableCardId is not provided

recipientNickName

string

Nick name of the recipient. Optional when creating a new card

recipientPhoneNumber

string

required

Recipient phone number. Required when action is CREATE or when reloadableCardId is not provided. Example: +972507471111

recipientCity

string

Recipient city. Optional when creating a new card

recipientState

string

Recipient state. Optional when creating a new card

recipientCountry

string

required

Recipient country in ISO 3166-1 alpha-2 format (2-letter country code). Required when action is CREATE or when reloadableCardId is not provided

recipientPostalCode

string

Recipient postal code. Optional when creating a new card

recipientAddress

string

Recipient address. Optional when creating a new card

feePaidBy

string

enum

required

Defaults to PAYER

Who pays the fee

Allowed:

action

string

enum

required

Action type

Allowed:

reloadableCardId

number

Required for action = ADD_FUNDS. Must not be provided for action = CREATE. ID of existing reloadable card to add funds to.

Responses

400

Invalid request parameters

401

Possible errors: credentials_invalid, credentials_expired

429

Too many requests

500

Service unavailable

Language

Credentials

URL

Loading…

Response

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

application/json

201