Create Beneficiary RESTful API

API Details

When working with this endpoint note that:

  • Unlike the Direct Debit payment API, Beneficiary and CT requests do not require a Creditor Scheme ID or SUN reference.
  • Before you can initiate a payment via the Create Credit Transfer request you must first create a beneficiary.
  • Alternatively it is possible to generate a new beneficiary and a payment in a single request. See the Create Credit Transfer and Beneficiary request.

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