Create a transfer

Trigger an action to perform a Transfer.

Body Params
amount
object
required

Amount of the Transfer. Cannot be negative, so the source must be the account from where the funds originate.

uuid

Unique identifier of the Account from where the amount will come from. If this one is sent, a targetAccountId is required.

uuid

Unique identifier of the Account to which the amount will go to. If this one is sent, a sourceAccountId is required.

uuid

Unique identifier of the Provider where the Accounts are hosted. Should not be present if using Payrails Ledger. If provided, then a pair of providerTargetAccountId and providerSourceAccountId is required.

string

Unique identifier of the Account from where the amount will be debited. If this one is sent, a providerTargetAccountId is required.

string

Unique identifier of the Account from where the amount will be credited. If this one is sent, a providerSourceAccountId is required.

string

Merchant-specific reference for the Transfer.

string

Human-readable description for the Transfer.

meta
object

Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide.

Responses

Language
Credentials
Bearer
JWT
Response
Choose an example:
application/json