Create a Transfer

post

https://api-dev.prolifepayments.com/payments/v1/transfers

Body Params

amount

string

required

The amount to be transferred.

customer

string

required

The ID of the Customer receiving this Transfer.

currency

string

required

Three-letter ISO currency code (lowercase). Currently, only "usd" is supported.

destinationPaymentMethod

string

required

The ID of the payment method used as the destination for this Transfer.

sourceUserDetails

object

Information about the account user initiating the transfer.

description

string

A custom description for the transfer.

Headers

idempotencyKey

string

A unique identifier to ensure the same operation isn't processed multiple times, preventing duplicate transactions.

onBehalfOf

string

Specifies the account for which the Transfer creation is intended. This is used for scenarios where one partner processes payments on behalf of another partner, such as in PayFac or related partner relationships.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200200

400400