Create Credit Transfer & Beneficiary RESTful API - generate a payment and its beneficiary in a single API call.

API Details

The Create Credit Transfer request requires that you have first created a beneficiary. In some scenarios it is simpler to generate both the beneficiary and the payment at the same time and this request allows you to do that.

Idempotency

The Idempotency check is only against successful requests, so where a previous call has resulted in any of the following HTTP Response Codes, that Idempotency key may be reused without any issue:

  • 401
  • 403
  • 404
  • 408
  • 500
  • 501
  • 503

SEPA Credit Transfers

When creating a SEPA Credit Transfer (also referred to as an SCT or CT) payments, note that:

  • Payments are processed for EUR currency payments only
  • CT payments, unlike Direct Debit payments, do not require that the transaction is passed to the SEPA Clearing system days in advance of the collection date.
  • If you create your CT payment early enough on a specific working day (before 8AM GMT), the funds will typically be credited to your beneficiary on the same day.
  • If you create the payment later in the day then the CT will generally be credited to the beneficiary on the following business day.

Faster Payments

The Faster Payments Scheme (FPS) is an instant payment scheme (with funds being credited to the beneficiary generally in a matter of seconds) available in the UK. Note that FPS:

  • Is available for GBP curency payments only.
  • Unlike SEPA CT, FPS is a 24/7/365 system.
  • Requires the following values in your request:
    • paymentCurrency = GBP.
    • type = EXPRESS

Payment Types

Payments can have a type:

  • STANDARD
  • EXPRESS
  • FASTEST_POSSIBLE
Currency Default Type CT Type
EUR STANDARD SCT
EUR EXPRESS SCT Instant
GBP STANDARD Bacs Direct Credit
GBP EXPRESS FPS

By default EUR payments are processed as STANDARD; GBP payments are processed as EXPRESS.

Where you specify FASTEST_POSSIBLE a payment will go via the the Express payment if possible (i.e. if configured for you); if it is not possible to send the payment as Express then the transaction will be processed as a Standard payment.