Create Credit Transfer & Beneficiary

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

API Details

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

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.

Note: If the beneficiary details you reference in the request have been previously provided (and that beneficiary is already stored against your merchant profile) Nuapay will reuse that stored beneficiary data: a new beneficiary is only created if his/her beneficiary account has not been referenced before in a previous Credit Transfer payment.

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

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.

Important: A Note on GMT: Nuapay apply Daylight Savings Time (DST) during the summer months (which is commonly referred to as British Summer Time (BST)). BST runs from the last Sunday in March to the last Sunday in October. During this period the cut off time is actually GMT -1 (so 07:00 GMT); during the period from November to the end of March, the cut off time is 08:00 GMT.

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

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

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.

Tip: If you would like a different default configuration, please discuss your requirements with your account manager.

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.

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).

Tip:

We now offer API Version 2 (V2) with asynchronous Credit Transfer processing for better performance. We encourage new clients to implement V2. Existing clients can continue using Version 1 (V1) with synchronous processing, which will continue to be supported. For more information or assistance, please contact support.

V2 Asynchronous
V1 Synchronous