Create Beneficiary | Nuapay Developer Hub

Create Beneficiary RESTful API

API Details

Important: The JWS-Signature header is required for this endpoint.

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.

Note: at its most basic, a beneficiary requires a name and a bank account reference. Additional data may also be stored but is not mandatory (address details and contact details, for example)

Tip: If you specify domestic account details for the beneficiary account, specify the Sort Code in domesticBranchCode (not in the domesticBankCode).

Idempotency

Tip: We recommend that you use a unique idempotency key when working with this endpoint. The Idempotency-Key is a Header parameter in this API.

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

Swagger Reference: Direct Debits & Credit Transfers

Note:

When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.

LIVE     https://api.nuapay.com
SANDBOX  https://sandbox.nuapay.com/

If you haven't done so already and would like to do some testing, please Request Sandbox Access

Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).