Initializing a gift card transfer.

post

https://api.stage.payouts.com/api/v1/gift-card-payment/transfers

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

Required permissions for this API:

and:

or: WRITE:TRANSFERS

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requestId

string

required

Idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

paymentDate

string | null

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. Real amount depends on feePaidBy value

feePaidBy

string

enum

Defaults to PAYER

Denotes whether PAYER / BENEFICIARY will be liable for the the payment fee. Defaults to PAYER unless field is populated in the request

Allowed:

prepaidProduct

string

required

Product code you would like to use

prepaidProductCountry

string | null

Product country

reason

string

Reason

reference

string

Reference

internalReference

string

Internal reference

verificationType

string

enum

required

Type of verification to be used for this transfer.
If operation type of the transfer is RELOAD, then this field is ignored and will be set to NONE

Allowed:

recipientReference

string | null

A unique recipient reference per unique recipient.
When a reference is re-used for a subsequent transfer it will reload already issued card.
Required for RECIPIENT distribution method and ignored for others

recipientType

string

enum

required

Type of the recipient

Allowed:

recipientFirstName

string | null

First name of the recipient

recipientLastName

string | null

Last name of the recipient

recipientCompanyName

string | null

Company name of the recipient

recipientEmail

string

required

Email address of the recipient

recipientNickName

string | null

Nick name of the recipient

recipientPhoneNumberCountry

string | null

Recipient phone number country

recipientPhoneNumberCode

string | null

Recipient phone number code

recipientPhoneNumber

string | null

Recipient phone number

recipientCity

string | null

Recipient city

recipientState

string | null

Recipient state

recipientCountry

string | null

Recipient country

recipientPostalCode

string | null

Recipient postal code

recipientAddress

string | null

Recipient address

verificationExpiryHours

number

1 to 1000

Defaults to 720

Verification expiry hours

distributionMethod

string

enum

required

Distribution method

Allowed:

Responses

400

401

Invalid API Key

429

Rate limit exceeded

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