Create deferred transaction with Group

Creates a deferred transaction request that is automatically grouped.

This endpoint creates a deferred TransactionRequest in the system that is automatically and immediately grouped into a deferred transaction group.

You must provide either a recipient object or a StoredRecipientRequest object if you wish to use a previously stored recipient in this transaction.

The response is an object that contains both the TransactionResponse and DeferredTransactionGroup details.

PropertyTypeDescription
GroupDeferredTransactionGroupThe DeferredTransactionGroup created.
TransactionTransactionResponseThe TransactionResponse created.

Calling this endpoint is the functional equivalent of calling Create (deferred transaction) followed by Create Group.

📘

We've made this simple...

Please note that the body parameters have been simplified for ease of use here. Please see the TransactionRequest data type for a full description of all fields and sub-types.

📘

Roles Required

Authentication tokens must possess the DeferredTransactionRequests.Create and DeferredTransactionGroups.Create roles to use this endpoint.

Body Params
int32
required

Group ID of locked rates. See Create rate group for more info.

string

External reference 1

string

External reference 2.

string

External reference 3.

string
required

The currency you are sending (making a payment with), specified as an ISO 4217 currency code.

double
required

The amount the recipient should receive, in the recipient's specified currency.

Recipient
object

Recipient of the payment.

string

Optional route type to specify the type of payment. Valid values are BankAccount, Cheque, BankGirot or PayByEmail.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json