Create External Card Push Transfer

This API facilitates the transfer of funds to an external card. To initiate a transfer, you must specify the card Id.

Specify Card ID: Provide the unique identifier of the external card where funds will be transferred. Initiate Transfer: Execute the API call to push the specified amount of funds to the external card.

Please checkout the page at External/Acquired Cards to understand more about this Payment Rail.

Please refer to this API Add an Acquired Card on how to generate the card cardId

Note: All the payment API's have the endpoint: /payments

Body Params

This API facilitates the transfer of funds to an external card. To initiate a transfer, you must specify the card Id.

Specify Card ID: Provide the unique identifier of the external card where funds will be transferred. Initiate Transfer: Execute the API call to push the specified amount of funds to the external card.

Please checkout the page at External/Acquired Cards to understand more about this Payment Rail.

Please refer to this API Add an Acquired Card on how to generate the card cardId

Note: All the payment API's have the endpoint: /payments

string
enum
required

Specifies the type of payment. Allowed values: CREDIT. Example: CREDIT

Allowed:
string
enum
required

Indicates the payment network used. Allowed values: CARD Example: CARD

Allowed:
number
required

The payment amount. BigDecimal; integer part max 12 digits, fraction part max 24 digits. Example: 10.99

originator
object
required

The details of the originator for the transfer.

recipient
object
required

The card details to pull the funds from.

string

The correlationId for the transfer. Maximum length: 100 characters. Unique identifier for tracking the transaction.

string
length ≤ 140

Optional reference or description for the transaction. Example: Transfer Funds into Amex Card

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json