This endpoint allows creation of a group of deferred transaction requests.

The transaction requests to group are sent in the request as an array of transaction request Ids.

When successful, the response is a DeferredTransactionGroup containing details of the group created.

The response you receive contains details of the PayInAccount that you use to fund the transactions in the group, and there are two options that you will see from the API. The most typical is a set of bank account details, such as the following...

{
  ...
  "PayInAccount":
  {
    "Name" : "Vitesse GBP",
    "Details":
    {
      "AccountNumber": "12345678",
      "SortCode": "112233"
    }
  },
  ...
}

This provides you with all data required to fund the deferred transaction group as it provides the full set of bank account details.

The other possible return from the API is where we collect funds via Direct Debit - in this case there is no need for you to fund the DTX group directly, as we can automatically debit funds from you. If you wish to investigate this mode of funding, please contact your account manager or email our support desk ([email protected]) and we'll discuss if this option is available to you as we don't have direct debit support in all countries. If direct debit funding is enabled for your account you will receive a response as follows...

{
  ...
  "PayInAccount":
  {
    "DirectDebit" : "True"
  },
  ...
}

Please note that the DirectDebit element will only be included in the response if the DTX group is funded by direct debit - it does not appear in the regular account style response.

❗️

No API Explorer

Sorry, the API Explorer is not available for this endpoint at the moment. This is due to a limitation in the tool we use to produce this guide.

📘

Role Required

Authentication tokens must possess the DeferredTransactionGroups.Create role to use this endpoint.