The Validate Account service allows you to pass either domestic account details (BBAN) to retrieve an IBAN or to pass an IBAN and retrieve the domestic account details.
Edit me

API Details

The Validate Account service allows you to:

  • Validate an IBAN.
  • Validate a domestic account (also referred to as a Basic Bank Account Number - BBAN)
Usage Pass either an IBAN or the domestic account number, country and other required parameters, based on the country selected.
Method POST
URI /iban/validate
Required Arguments domesticAccountNumber
The account number. Only required if validating a domestic account
The ISO country code. Only required if validating a domestic account.
The account in IBAN format. A required argument if you are validating an 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.
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.
429 Too Many Requests. 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.

Note: For a more detailed view of this API see the OpenAPI/Swagger redoc: OpenAPI/Swagger Reference