API Details
Unlike the Direct Debit payment API, Beneficiary and CT requests do not require a Creditor Scheme ID 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.
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
| Usage | You must provide the name and the account details to create a beneficiary |
| Method | POST |
| URI | /beneficiaries |
| Required Arguments | beneficiary.name, beneficiaryAccount.iban |
A successful request will return a 201 Created response code
The following is the complete list of possible status codes, which may be returned in the response:
| Status Code | Description |
|---|---|
| 200 | OK - The request completed successfully. |
| 201 | Created - A new resource has been created successfully. The resource is appended to the response. |
| 400 | Bad Request - The request was malformed. The response body will include an error providing further information. |
| 401 | Unauthorized - Your API key is wrong. |
| 403 | Forbidden - The client has provided a valid Authentication header, but it does not have permission to access this resource. |
| 404 | Not Found - The requested resource did not exist. |
| 405 | Method Not Allowed - When a HTTP method is being requested that isn’t allowed. |
| 410 | Gone - The API requested has been removed from our servers. |
| 412 | Precondition Failed - Certain unmet conditions must be fulfilled before the request to be processed e.g. timestamp is too old. |
| 415 | Unsupported Media Type - If incorrect content type was provided as part of the request (e.g. other than “application/json”). |
| 422 | Unprocessable Entity - Used for validation errors. More details will be provided in response body. |
| 500 | Internal Server Error - We had a problem with our server. Try again later and if the problem persists contact the Nuapay application support team. |
| 501 | Not Implemented - When the endpoint is not implemented yet. |
| 503 | Service Unavailable - We’re temporarially offline for maintanance. Please try again later. |
Note: For a more detailed view of this API see the: API Reference