API Details
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 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. (See the Important Note below for more on this).
- 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 Express channel if possible; if it is not possible to send the payment as Express then the transaction will be processed as a Standard payment.
Remittance Information
Remittance Information allows you to specify details of the payment to your beneficiary.
- This information may be used for reconciliation and will be displayed on the payee’s bank statement.
- Remittance can be passed in one of two fields.
Depending on the currency of the payment, use the correct remittance value as outlined in the table below:
Currency | Field | Details |
GBP | structuredRemittanceInformation.creditorReference |
While 35 characters are possible, only 18 will be used (as per the Faster Payments scheme rules). If you provide > 18 characters, the remittance text will be truncated and only 18 will be passed in your request. |
EUR | remittanceInformation |
Up to a maximum of 140 characters may be used. |
remittanceInformation
(for EUR) or structuredRemittanceInformation.creditorReference
(for GBP) should be passed in your request; if both values are provided, you will receive a validation error.Supported Characters
Remittance can use the following characters:
- All alphanumeric characters (upper- and lower-case).
- A set of special characters.
The following are all allowed:
a b c d e f g h i j k l m n o p q r s t u v w x y z |
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
0 1 2 3 4 5 6 7 8 9 |
/ - ? : ( ) . , ‘ + Space |
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).