Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
9979 lines (9817 sloc) 368 KB
swagger: '2.0'
info:
description: '**** GENERATED BY Origix APPLICATION ****'
version: '1.0.0'
title: Origix REST API
termsOfService: For internal use only
contact:
name: sentenial
url: http://sentenial.com
email: engineering@sentenial.com
license:
name: For internal use only
url: https://sentenial.com
x-logo:
backgroundColor: '#FFFFFF'
url: https://docs.nuapay.com/api/images/logo.png
host: api.nuapay.com
basePath: /
tags:
- name: Introduction
description: |-
Welcome to the Nuapay REST API. Processing Direct Debits (DDs) or Credit Transfers (CTs) via API is a simple way to integrate these payment methods into your systems. This API reference provides information on available endpoints and how to interact with them.
For Direct Debits once you have been configured with a Creditor Scheme ID just add the mandate, add the Direct Debit or Direct Debit Schedule and watch your payments come in. If you're new to Direct Debits refer to our <a href = 'https://sentenial.github.io/developer-docs/np_landing_page.html' target='_blank' >Developer Documentation</a> for an overview of the Direct Debit process.
For Credit Transfers, add the Beneficiary then add the Credit Transfer and your payment is sent out. If you're new to Credit Transfers refer to this <a href= 'https://sentenial.github.io/developer-docs/np_ctoverview.html' target='_blank' >Credit Transfer Payments Overview</a>.
- name: Getting Started
description: |-
To register for the service and get your API key, visit <a href=' https://www.nuapay.com/request-api-sandbox/' target='_blank' >https://www.nuapay.com/request-api-sandbox/</a> or e-mail: [api.support@nuapay.com](mailto:api.support@nuapay.com)
If you prefer to talk to someone, call 00353 (0)1 901 2398.
We'll have you up and running in no time.
- name: API Endpoints
description: |-
Once you have your API key, you can send requests to the following endpoints:
`Live: https://api.nuapay.com`
`UAT: https://sandbox.nuapay.com/`
Our APIs are RESTful and we use JSON format for submitting and retrieving data.
<!-- A note on IDs: All IDs used in URIs are encoded. IDs used in request bodies are unencoded. -->
To view all available Nuapay REST endpoints, see the [Resources](#tag/Returned-Resources) sections below.
<aside class='notice'>
If you choose to use Java to integrate with our API, then you can make use of the <a href='https://github.com/sentenial/nuapay-rest-client' target='_blank'>Nuapay Java Rest Client</a> library.
</aside>
- name: Authentication
description: |-
Access to the API is controlled by HTTP Basic authentication.
Provide your API key as the basic authentication username, encoded in Base64. No password needs to be provided, however the request must be made from an allowed IP address configured in Nuapay.
API authentication header format:
`Authorization: Basic Base64(<API_Key>:)`
All API requests must be made over HTTPS, calls made over plain HTTP will fail. All API requests must be authenticated.
<br>
> To authorize, use this code:
```bash
# With curl, you can just pass BASIC auth header
# (-u option) with each request
$ curl 'https://api.nuapay.com/schemes/46pkx7o9n5/mandates'
-u bb09c2b6a9478720765c757a8bcadf1aa1fb31554566a21118c9c75e26c29686:
```
```java
// With java client library use following code to set up your ApiKey
ServiceConfiguration serviceConfig = new ServiceConfiguration();
serviceConfig.setApiKey('bb09c2b6a9478720765c757a8bcadf1aa1fb31554566a21118c9c75e26c29686');
RetrieveMandateResponse retrieveMandateResponse =
new MandateServiceDefault(serviceConfig)
.retrieveMandate('46pkx7o9n5', '46pkx7o9n5');
```
> Make sure to replace `bb09c2b6a...` with your API key.
<br>
- name: Output Encoding Rules
description: |-
The code converts untrusted input into a safe form where the input is displayed as data to the user without executing as code in the browser.
The implementation is based off the <a href='https://www.owasp.org/index.php/XSS_(Cross_Site_Scripting)_Prevention_Cheat_Sheet#Output_Encoding_Rules_Summary' target='_blank' >OWASP recommendations</a>.
- name: JWS-Signature Header
description: |-
The JWS-signature header is used to verify requests made to certain endpoints, it is generated based on the request body to be sent,
a customer private key and X.509 certificate issued by Nuapay.
For details on how to generate a private key and obtaining an X.509 certificate see the security section of the <a href = 'https://sentenial.github.io/developer-docs/np_secjwsgenerator.html' target='_blank'>Developer Resource</a> pages.
The JWS-signature is required when using the following POST / PUT endpoints,
* Create Beneficiary
* Create Credit Transfer
Optionally the JWS-signature can also be applied to the following POST / PUT endpoints,
* Create Mandate
* Upload Mandate Document
* Update Mandate
* Activate Mandate
* Cancel Mandate
* Create Direct Debit
* Create Direct Debit & Mandate
* Revoke Direct Debit
* Revoke All Direct Debit
* Re-present Failed Direct Debit
* Create Schedule
* Create Schedule & Mandate
* Cancel Schedule
* Upload File
The JWS-signature is not required for GET endpoints.
<br>
> Example JWS-Signature Header
``` json
JWS-Signature: eyJiNjQiOmZhbHNlLCJjcml0IjpbImI2NCIsImlhdCIsImlzcyJdLCJraWQiOiIxNzk2NDU1MDI1IiwiaXNzIjoiT1VcdTAwM2ROdWFwYXkgQVBJLExcdTAwM2RMb25kb24sT1x1MDAzZE51YXBheSxDXHUwMDNkR0IsQ05cdTAwM2RvbWdkMzZkcG1rIiwiYWxnIjoiUlMyNTYiLCJpYXQiOjB9..wE6Cal9Hh62YKjjD4BbQpdPc1IwtteZ-ys3aiOWJDVLFdVxnJ0pEvcsK1nfRnfiiqCOB9PbapNrpG1e3jdWA3y-bm0KphLE52PEwhWZkD-x3WeFyxAeZT_Ma7Fem08k31ifMLMPYkXAyUDUfCao4DHJQHmOWQuDawYC4lH4qtiI
```
- name: Returned Resources
description: |-
All resources returned by endpoints are contained within a resource envelope.
For single entities, the JSON envelope has the following structure:
JSON Path | Type | Description
---- | ---- | -----------
uri | String | Resource URI
data.id | String | Resource ID
data.uri | String | Resource URI
data.* | | Resource content
For collections, the JSON envelope contains the following structure:
JSON Path | Type | Description
---- | ---- | -----------
uri | String | Collection resource URI
data | Collection | Collection of resources
data[].id | String | Resource ID
data[].uri | String | Resource URI
data[].* | | Resource content
data.page | Pagination object | Meta-data related to pagination
data.sort | Sort object | Meta-data related to sorting (currently empty)
<aside class='warning'>
NOTE: <strong>data.id</strong> is a Resource ID that is used as an URI parameter. When building the URI to view or update resource the id is to be used. <strong>data.uri</strong> contains ready to use URI of the resource returned.
</aside>
<br>
> Example response with single entity
``` json
{
'uri' : '/files/23qzxn1f7m',
'data' : {
'id' : '23qzxn1f7m',
'uri' : '/files/23qzxn1f7m',
'originalFileName': 'originalFileName.xml',
'newFileName': 'newFileName.xml.QUEUED'
}
}
```
> Example response with collection
``` json
{
'uri' : '/schemes/8g3o2yyk2w/mandates',
'data' : [ {
'id' : '46pkxn8e9n',
'uri' : '/schemes/8g3o2yyk2w/mandates/46pkxn8e9n',
'mandateId' : 'b8b7ee91-b403-4ecb-9d98-059746dd8149',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
}
],
'page' : {
'pageNumber' : 1,
'pageSize' : 1,
'totalElements' : 1,
'totalPages' : 1
},
'sort' : [ ]
}
```
- name: Resource IDs
description: |-
The ID is part of resource URI and in this documentation is marked as such by placing it between curly brackets. Sample scheme resource URI is `/schemes/{schemeId}/mandates/{mandateId}` where `schemeId` and `mandateId` are the Scheme and Mandate Resource IDs accordingly.
<aside class='warning'>
NOTE: Resource ID is not a business identifier, it is a technical ID assigned during the POST of a new resource and is available in the response ID property. This ID can then be used to query the resource.
</aside>
<aside class='notice'>
NOTE: <strong>data.uri</strong> is a Resource URI that contains related Resource IDs as well. For complex URIs, where the Resource belongs to another Resource, the <strong>data.uri</strong> element returns ready to use URI containing all related Resource IDs
</aside>
[Returned Resources](#tag/Returned-Resources) `data[].id` element contains the Resource ID. In above example [Mandate Resource](#operation/viewMandateUsingGET) needs to be retrieved to get the `mandateId` and [Creditor Scheme Resource](#operation/listCreditorSchemesUsingGET) needs to be retrieved to get `schemeId`.
- name: Links
- name: Transactions
description: |-
Transaction is a resource that describes a posting to an account that results in an increase or decrease to a balance of the account.
To access transaction use following URL: [https://api.nuapay.com/accounts/{accountId}/transactions/{transactionId}](https://api.nuapay.com/accounts/{accountId}/transactions/{transactionId}) where
* accountId, is the Account resource ID.
* transactionId, is the Transaction resource ID.
- name: Transaction Types
description: |-
The following table contains a list of the transaction types that can be returned as part of the 'List Transaction' and 'View Transaction' endpoints.
Transaction | Transaction Type | Debit Credit Indicator | Counterparty
----------- | ---------------- | ---------------------- | ------------
Credit Transfer Bank Reject | CREDIT_TRANSFER_BANK_REJECT | CREDIT | Debtor
Direct Debit Batch | DIRECT_DEBIT_BATCH | CREDIT | Debtor
Direct Debit Bank Cancellation | DIRECT_DEBIT_BANK_CANCELLATION | DEBIT | Creditor
Direct Debit Reject | DIRECT_DEBIT_REJECT | DEBIT | Creditor
Direct Debit Reversal | DIRECT_DEBIT_REVERSAL | DEBIT | Creditor
Direct Debit Return | DIRECT_DEBIT_RETURN | DEBIT | Creditor
Direct Debit Refusal | DIRECT_DEBIT_REFUSAL | DEBIT | Creditor
Direct Debit Authorized Refund | DIRECT_DEBIT_AUTHORIZED_REFUND | DEBIT | Creditor
Direct Debit Unauthorized Refund | DIRECT_DEBIT_AUTHORIZED_REFUND | DEBIT | Creditor
Outgoing Credit Transfer | OUTGOING_CREDIT_TRANSFER | DEBIT | Creditor
Availability Fee | AVAILABILITY_FEE | DEBIT | N/A for Fees
Direct Debit Batch Transactions Fee | DIRECT_DEBIT_BATCH_TRANSACTIONS_FEE | DEBIT | N/A for Fees
Direct Debit R-Transaction Fee | DIRECT_DEBIT_RTRANSACTIONS_FEE | DEBIT | N/A for Fees
Credit Transfer Reject Fee | CREDIT_TRANSFER_RTRANSACTION_FEE | DEBIT | N/A for Fees
Incoming Credit Transfer | INCOMING_CREDIT_TRANSFER | CREDIT | Debtor
Credit Transfer Recall | CREDIT_TRANSFER_RECALL | CREDIT | Debtor
E-Mandate Setup Fee - CORE Scheme | CORE_EMANDATE_SETUP_FEE | DEBIT | N/A for Fees
E-Mandate Setup Fee - BACS Scheme | BACS_EMANDATE_SETUP_FEE | DEBIT | N/A for Fees
E-Mandate Setup Fee - B2B Scheme | B2B_EMANDATE_SETUP_FEE | DEBIT | N/A for Fees
E-Mandate Fee - CORE Scheme | CORE_EMANDATE_FEE | DEBIT | N/A for Fees
E-Mandate Fee - BACS Scheme | BACS_EMANDATE_FEE | DEBIT | N/A for Fees
E-Mandate Fee - B2B Scheme | B2B_EMANDATE_FEE | DEBIT | N/A for Fees
Outgoing Credit Transfer Fee | OUTGOING_CREDIT_TRANSFER_FEE | DEBIT | N/A for Fees
Incoming Credit Transfer Fee | INCOMING_CREDIT_TRANSFER_FEE | DEBIT | N/A for Fees
Credit Transfer Recall Fee | CREDIT_TRANSFER_RECALL_FEE | DEBIT | N/A for Fees
Overdraft Fee | OVERDRAFT_FEE | DEBIT | N/A for Fees
- name: Balances
description: Balances endpoints
- name: Mandates
description: |-
Mandates are associated to a Creditor Scheme (CORE or B2B) and enable the collection of funds from a debtor's account to a creditor's account via a Direct Debit.To access a mandate use the following URL: `https://api.nuapay.com/schemes/{schemeId}/mandates/{mandateId}`
where
* `schemeId`, is the Creditor Scheme resource ID returned by [List Creditor Schemes](#operation/listCreditorSchemesUsingGET)
* `mandateId`, is the Mandate resource ID returned by a variety of mandate services including: [Create Mandate](#operation/addMandateUsingPOST), [List Organization Mandates](#operation/listOrganizationMandatesUsingGET),[List Scheme Mandates](#operation/listSchemeMandatesUsingGET), [Retrieve Mandate](#operation/viewMandateUsingGET)
- name: Other
description: Other endpoints
- name: Credit Transfers
description: |-
Credit tranfers are the financial transactions associated to the beneficiary.
To access credit transfers use the following URL:
`https://api.nuapay.com/beneficiaries/{beneficiaryId}/credittransfers/{creditTransferId}`
where
* `beneficiaryId`, is the Beneficiary resource ID returned by a variety of beneficiary services including: [Create Beneficiary](#operation/addBeneficiaryUsingPOST), [List Beneficiaries](#operation/listBeneficiariesUsingGET), [Retrieve Beneficiary](#operation/viewBeneficiaryUsingGET)
* `creditTransferId`, is the Credit Transfer resource ID returned by a variety of credit transfers services including: [Create Credit Transfer](#operation/addCreditTransferUsingPOST), [Retrieve Credit Transfer](#operation/viewCreditTransferUsingGET)
- name: Direct Debits
description: |-
Direct debits are the financial transactions associated to the mandate.
To access direct debits use the following URL:
`https://api.nuapay.com/schemes/{schemeId}/mandates/{mandateId}/directdebits/{directDebitId}`
where
* `schemeId`, is the Creditor Scheme returned by [List Creditor Schemes](#operation/listCreditorSchemesUsingGET)
* `mandateId`, is the Mandate is returned by a variety of mandate services including: [Create Mandate](#operation/addMandateUsingPOST), [List Organization Mandates](#operation/listOrganizationMandatesUsingGET),[List Scheme Mandates](#operation/listSchemeMandatesUsingGET), [Retrieve Mandate](#operation/viewMandateUsingGET)
* `directDebitId`, is the Direct Debit returned by a variety of direct debit services including: [Create Direct Debit](#operation/addSinglePaymentUsingPOST), [List Organization Direct Debits](#operation/listDirectDebitsOrganizationUsingGET), [List Scheme Direct Debits](#operation/listDirectDebitsSchemeUsingGET), [List Mandate Direct Debits](#operation/listDirectDebitsSchemeMandateUsingGET), [Retrieve Direct Debit](#operation/viewDirectDebitUsingGET)
- name: Payment Schedules
description: |-
Payment Schedules allow you to set up a number of payments against a mandate in one go. Schedules can be Fixed-Length (e.g. collect €10 each month for 12 months) or Open-Ended (e.g. collect €10 every month with no fixed number of payments being defined).
To access payment schedules use the following URL:
`https://api.nuapay.com/schemes/{schemeId}/mandates/{mandateId}/directdebits/{directDebitId}`
where
* `schemeId`, is the Creditor Scheme resource id returned by [List Creditor Schemes](#operation/listCreditorSchemesUsingGET)
* `mandateId`, is the Mandate resource id returned by a variety of mandate services including: [Create Mandate](#operation/addMandateUsingPOST), [List Organization Mandates](#operation/listOrganizationMandatesUsingGET),[List Scheme Mandates](#operation/listSchemeMandatesUsingGET), [Retrieve Mandate](#operation/viewMandateUsingGET)
* `scheduleId`, is the Payment Schedule resource id returned by a variety of payment schedule services including: [Create Schedule](#operation/addPaymentScheduleUsingPOST), [List Originator Payment Schedules](#operation/listPaymentSchedulesMandateUsingGET), [List Mandate Payment Schedules](#operation/listPaymentSchedulesMandateUsingGET) [Create Schedule & Mandate](#operation/addPaymentScheduleUsingPOST_1)
- name: Creditor Schemes
description: 'The Creditor Schemes associated to the Merchant. Each scheme will have a unique Creditor Scheme ID and a Scheme Type, CORE, B2B etc.'
- name: Files
description: A `POST` request used to upload a file. A request must contain the `multipart/form-data` content type with a `json` part containing input parameters in a JSON structure and a `file` part with file content.
- name: Accounts
description: Accounts endpoints
- name: Beneficiaries
description: |-
Beneficiaries are the Credit Transfer receivers, also known as the payees or creditors. They enable the funds transfer from the debtor's (Originator/Merchant) account to a creditor's account via Credit Transfer.
To access a beneficiary use the following URL:
`https://api.nuapay.com/beneficiaries/{beneficiaryId}`
where
`beneficiaryId`, is the resource ID returned by [List Beneficiaries](#operation/listBeneficiariesUsingGET)
- name: Validate Accounts
description: Validate Accounts endpoints
- name: About Responses
description: |-
Every API Request will generate a HTTP Response. This will contain a HTTP Response Code to indicate the status of the Request. In addition certain HTTP Responses (400, 422) may generate an Error Response with an Error Code.
- name: HTTP Status Codes
description: |-
You may encounter the following response codes. Selected response codes will contain more information to help identify problems.
<nobr>Status Code</nobr> | Usage
---------- | -------
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.
- name: Errors
description: |-
Whenever an error response with status `400` or `422` is returned, the body will contain a JSON object that describes the problem. The error object has the following structure:
Path | Type | Description
---- | --------- | -----------
returnCode | String | Error Code
returnDescription | String | Error description
details | Array | The object holds collection of validation errors. It is returned only for `returnCode` equal to `8888`,`9999`.
details[].code | String | Error Code
details[].field | String | JSON path to request object property the error is related to
details[].description | Error description |
details[].resourceUri | String | This property holds existing resource URI in case the validation error states the resource already exist and can't be created. It is returned only for `returnCode` equal to `9999`.
See [Error Codes](#tag/Error-Codes) section for details.
<br>
> For example, a request that attempts to create a payment schedule with invalid start date will produce a
`400 Bad Request` response:
``` http
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
'returnCode' : '7043',
'returnDescription' : 'Start date is invalid'
}
```
- name: Error Codes
description: |-
Following is the list of error codes with description as a possible return when request failed:
Code | Description
---- | -----------
2005 | Debtor Account Validation Error <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
2006 | The Creditor Account referenced within the file does not exist within the system <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3001 | The debtor language must be provided <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3002 | The language parameter is incorrect <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3003 | The debtor address line 1 must be provided <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3004 | The debtor country must be provided <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3006 | The address parameter is mandatory when paper handling is set to true <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3007 | The country is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3008 | The debtor town must be provided <em>[Create mandate](#operation/addMandateUsingPOST) [Update mandate](#operation/editMandateUsingPUT)</em>
3009 | The Mandate cannot be edited from its current state <em>[Update mandate](#operation/editMandateUsingPUT)</em>
3010 | Mandate cannot be cancelled from its current state <em>[Cancel Mandate](#operation/cancelMandateUsingPOST)</em>
3021 | A Payment already exists against a ONCE_OFF mandate <em>[Create direct debit](#operation/addSinglePaymentUsingPOST)</em>
3022 | The Mandate cannot be Activated from its current state <em>[Activate mandate](#operation/activateMandateUsingPOST)</em>
3023 | Mandate could not be added due to missing PDF template <em>[Create mandate](#operation/addMandateUsingPOST)</em>
3024 | The debtor e-mail must be provided <em>[Create mandate](#operation/addMandateUsingPOST)</em>
3025 | The debtor mobile number must be provided <em>[Create mandate](#operation/addMandateUsingPOST)</em>
3026 | Mandate Type not supported in current configuration <em>[Update mandate](#operation/editMandateUsingPUT)</em>
3027 | A Mandate exists in the system with the specified SEPA mandate ID. This ID must be unique for an Originator <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3028 | In Respect of Contract ID not provided <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
3029 | No SEPA Mandate ID Provided <em>[Create mandate](#operation/addMandateUsingPOST)</em>
3030 | Language is not supported by originator <em>[Create mandate](#operation/addMandateUsingPOST)</em>
4003 | Payment Date is not a working day <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4004 | Date format invalid <em>[Create direct debit](#operation/addSinglePaymentUsingPOST)</em>
4005 | Payment Date is not far enough in the future <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4006 | Invalid Number of Payments <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4007 | Invalid Schedule Reference <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4008 | Payment Date is too far in the future <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4009 | Payment Amount is invalid <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4011 | First Payment Amount Invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4013 | Last Payment Amount Invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4016 | Representation is not enabled for the creditor scheme <em>[Represent failed direct debit](#operation/representDirectDebitUsingPOST)</em>
4019 | End To End Id is invalid <em>[Create direct debit](#operation/addSinglePaymentUsingPOST)</em>
4021 | Direct Debit cannot be revoked as it is not in a valid status <em>[Revoke direct debit](#operation/revokeDirectDebitUsingPOST)</em>
4022 | No Direct Debit exists matching information provided <em>[Revoke all direct debits](#operation/revokeAllDirectDebitsUsingPOST)</em>
4023 | Direct Debit is not in a valid condition for Representation <em>[Represent failed direct debit](#operation/representDirectDebitUsingPOST)</em>
4024 | Invalid Representation Fee amount <em>[Represent failed direct debit](#operation/representDirectDebitUsingPOST)</em>
4025 | Invalid Representation Date <em>[Represent failed direct debit](#operation/representDirectDebitUsingPOST)</em>
4029 | Number of Payments not provided <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4031 | Final Payment amount should not be provided for an Open Ended Schedule <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4032 | Number of Payments should not be provided for an Open Ended Schedule <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4033 | Only a Start date should be provided for a Daily/Yearly Schedule <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4034 | Only Day of Week should be provided for a Weekly/Bi-Weekly Schedule <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4035 | Only Date in Month or Week in Month and Day of week should be provided for a Monthly schedule <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4036 | An Active schedule already exists on this mandate <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4039 | Payment Type must be Fixed Length on a Once off Mandate <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4040 | Number of Payments on a Once Off Mandate must be set to 1 <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
4041 | End To End Id is not unique <em>[Create direct debit](#operation/addSinglePaymentUsingPOST)</em>
4042 | Mandate is not in a Valid Status <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST), [Represent DD](#operation/representDirectDebitUsingPOST)</em>
4043 | No Direct Debit exists in a valid status <em>[Revoke all direct debits](#operation/revokeAllDirectDebitsUsingPOST)</em>
4048 | Payment Custom Frequency must be provided if Payment Schedule Frequency is set to CUSTOM <em>[Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
5001 | Invalid Beneficiary Account Details <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5002 | Duplicate Beneficiary Account Details Provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5004 | Beneficiary Country Required if any other Address element is provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5005 | Invalid Beneficiary e-mail address provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5006 | Payment Amount Invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5007 | Originator Account provided does not exist <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5008 | Invalid Payment Reference <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5009 | Invalid Date for Payment <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5014 | Transfer Failed. Please try again later <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5015 | Transfer Failed. Please contact support <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5016 | Insufficient Funds <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5017 | Originator account currency does not match payment currency <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7001 | Date format invalid <em>[List mandates](#operation/listSchemeMandatesUsingGET), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET),[List failed direct debits](#operation/listFailedDirectDebitUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7002 | 'From Date ' must be earlier or equal to 'To Date' <em>[List mandates](#operation/listSchemeMandatesUsingGET), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [List failed direct debits](#operation/listFailedDirectDebitUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7003 | Max date range is exceeded <em>[List mandates](#operation/listSchemeMandatesUsingGET), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [List failed direct debits](#operation/listFailedDirectDebitUsingGET)</em>
7004 | Boolean parameter value must be either 'true' or 'false' <em>[List failed direct debits](#operation/listFailedDirectDebitUsingGET), [Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST), [Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST), [Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
7005 | Max file size exceeded <em>[Upload file](#operation/uploadFileUsingPOST)</em>
7006 | Invalid file supplied. File extension does not match file format <em>[Upload file](#operation/uploadFileUsingPOST)</em>
7007 | Not allowed file format <em>[Upload file](#operation/uploadFileUsingPOST)</em>
7008 | Invalid file name <em>[Upload file](#operation/uploadFileUsingPOST)</em>
7009 | The Creditor Scheme ID/Type referenced does not exist within the system <em>[Upload file](#operation/uploadFileUsingPOST)</em>
7010 | Debtor Name is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [List mandates](#operation/listSchemeMandatesUsingGET)</em>
7011 | Address Line1 is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>, [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7012 | Address Line2 is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>, [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7013 | Address Town is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>, [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7014 | Address Postal Code is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>, [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7015 | Address State is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>, [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7016 | Address ISO Country Code is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>, [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7017 | Debtor Language is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7018 | Debtor Email is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7019 | Phone Number is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7020 | Mobile Number is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7021 | Mandate Id is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [List mandates](#operation/listSchemeMandatesUsingGET)</em>
7022 | Contract Reference is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7023 | Signature Location is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [Activate mandate](#operation/activateMandateUsingPOST)</em>
7024 | Signature Date is invalid or max length is exceeded <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [Activate mandate](#operation/activateMandateUsingPOST)</em>
7025 | Mandate Type is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7026 | Debtor IBAN is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT), [List mandates](#operation/listSchemeMandatesUsingGET)</em>
7027 | Debtor Bank BIC is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7028 | Creditor IBAN is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7029 | Creditor Bank BIC is invalid <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7030 | Mandate Source is invalid <em>[Update mandate](#operation/editMandateUsingPUT)</em>
7031 | Debtor Account IBAN is required <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7032 | Debtor object is required <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7033 | Debtor Account object is required <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7034 | Debtor name is required <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7035 | Remittance Information is invalid or max length is exceeded <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7036 | Requested Collection Date is required <em>[Create direct debit](#operation/addSinglePaymentUsingPOST)</em>
7037 | Payment Amount is required <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7038 | Payment Frequency is required <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7039 | Payment Type is required <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7040 | Start Date is required <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7041 | Payment Frequency is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7042 | Payment Type is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7043 | Start date is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7044 | Schedule Id is invalid or max length is exceeded <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [Revoke all direct debits](#operation/revokeAllDirectDebitsUsingPOST)</em>
7045 | Number of Payments is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7046 | Payment Day of Week is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7047 | Payment Week of Month is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7048 | Payment Day in Month is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7049 | ResendMandateForSignature is invalid <em>[Update mandate](#operation/editMandateUsingPUT)</em>
7050 | Page Number is invalid <em>[List mandates](#operation/listSchemeMandatesUsingGET), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7051 | Max page size is exceeded <em>[List mandates](#operation/listSchemeMandatesUsingGET), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7052 | Page size is invalid <em>[List mandates](#operation/listSchemeMandatesUsingGET), [List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7053 | Authorization Method is invalid <em>[Activate mandate](#operation/activateMandateUsingPOST), [Create mandate](#operation/addMandateUsingPOST)</em>
7054 | Authorization Token is invalid or max length is exceeded <em>[Activate mandate](#operation/activateMandateUsingPOST), [Create mandate](#operation/addMandateUsingPOST)</em>
7055 | Authorization email is invalid or max length is exceeded <em>[Activate mandate](#operation/activateMandateUsingPOST), [Create mandate](#operation/addMandateUsingPOST)</em>
7056 | Authorization Mobile Number is invalid or max length is exceeded <em>[Activate mandate](#operation/activateMandateUsingPOST), [Create mandate](#operation/addMandateUsingPOST)</em>
7057 | Ip Address is invalid or max length is exceeded <em>[Activate mandate](#operation/activateMandateUsingPOST), [Create mandate](#operation/addMandateUsingPOST)</em>
7058 | Geographic Location is invalid or max length is exceeded <em>[Activate mandate](#operation/activateMandateUsingPOST), [Create mandate](#operation/addMandateUsingPOST)</em>
7059 | Mandate Status is invalid <em>[List mandates](#operation/listSchemeMandatesUsingGET)</em>
7060 | End To End Id is invalid <em>[Create direct debit](#operation/addSinglePaymentUsingPOST), [Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST)</em>
7063 | Payment Status is invalid <em>[List direct debits](#operation/listDirectDebitsSchemeMandateUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7064 | Operation Reason exceeds maximum length <em>[Cancel Mandate](#operation/cancelMandateUsingPOST), [Revoke all direct debits](#operation/revokeAllDirectDebitsUsingPOST), [Revoke direct debit](#operation/revokeDirectDebitUsingPOST)</em>
7065 | Invalid Domestic Bank Code <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7066 | Invalid Domestic Branch Code <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7067 | Invalid Account Country <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7068 | Invalid Domestic Checksum <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7070 | The SEPA Creditor Scheme ID does not exist for the selected scheme <em>[Validate IBAN](#operation/validateDomesticAccountUsingPOST)</em>
7071 | No account associated to the creditor scheme <em>[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST), [Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
7072 | PDF could not be generated / retrieved <em>[Retrieve mandate document](#operation/getPdfFileUsingGET)</em>
7074 | Mandate Operation Reason not provided <em>[Cancel Mandate](#operation/cancelMandateUsingPOST), </em>
7075 | Domestic Account Number is required if IBAN is not provided <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7076 | Invalid Domestic Account Number <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7077 | Account Country is required if IBAN is not provided <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
7078 | 'Reject From Date' is required <em>[List failed direct debits](#operation/listFailedDirectDebitUsingGET)</em>
7079 | 'Reject To Date' is required <em>[List failed direct debits](#operation/listFailedDirectDebitUsingGET)</em>
7080 | Payment Custom Frequency is invalid <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7081 | Beneficiary IBAN is invalid <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7082 | Beneficiary Bank BIC is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7083 | Beneficiary Account IBAN is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7084 | Beneficiary object is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7085 | Beneficiary Account object is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7086 | Beneficiary Name is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7087 | Beneficiary Bank BIC is required if External Account Validation is OFF <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7088 | Beneficiary Language is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7089 | Beneficiary Email is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7090 | Requested Execution Date is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7091 | Originator IBAN is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7092 | Payment Currency is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7093 | Payment Currency is invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7094 | Beneficiary account is not reachable for GBP currency <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7096 | Description of Purpose is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7098 | Invalid IBAN <em>[Validate IBAN](#operation/validateDomesticAccountUsingPOST)</em>
7099 | Domestic Account details are not allowed if IBAN is provided <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST), [Validate IBAN](#operation/validateDomesticAccountUsingPOST)</em>
7100 | Beneficiary Name is invalid or max length is exceeded <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [Create beneficiary](#operation/addBeneficiaryUsingPOST), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7101 | Provided schedule details would create two payments for first collecting period. Please change schedule details or twoPaymentsSamePeriod flag <em>[Create payment schedule](#operation/addPaymentScheduleUsingPOST)</em>
7104 | Debtor Account Country does not match Scheme Country <em>[Create mandate](#operation/addMandateUsingPOST)</em>
7105 | Creditor Account Country does not match Scheme Country <em>[Create mandate](#operation/addMandateUsingPOST)</em>
7106 | Exported Mandates cannot be amnded when Edit Doc Handling / Regulatory Screening is enabled <em>[Update mandate](#operation/editMandateUsingPUT)</em>
7107 | Mandate Id and Debtor Account details cannot be amended when Debtor Mandate Flow is used <em>[Update mandate](#operation/editMandateUsingPUT)</em>
7108 | The file extension does not match that of the content-type header <em>[Upload Mandate Document](#operation/putPdfFileUsingPOST)</em>
7109 | The file size exceeds 2MB <em>[Upload Mandate Document](#operation/putPdfFileUsingPOST)</em>
7110 | The file name is invalid or exceeds the max length <em>[Upload Mandate Document](#operation/putPdfFileUsingPOST)</em>
7111 | Originator IBAN is invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7112 | Insufficient Funds <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7113 | Transfer Failed. Please try again later <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7114 | Transfer Failed. Please contact support <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7116 | A Once Off Mandate cannot have Migrating Mandate value true <em>[Update mandate](#operation/editMandateUsingPUT)</em>
7117 | BBAN specific fields not allowed <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
7118 | Payment schedule status is invalid <em>[List payment schedules](#operation/listPaymentSchedulesMandateUsingGET)</em>
7120 | Payment schedule cannot be cancelled as it is not in ACTIVE status [Cancel Payment Schedule](#operation/cancelPaymentScheduleUsingPOST)</em>
7123 | Mandate object is required <em>[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST),[Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
7124 | Current Creditor Scheme configuration does not allow to create mandate on the fly <em>[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST),[Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
7125 | Requested execution date is in the past <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7126 | Requested execution date is not a working day <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7127 | Requested execution date is today and Cut-off time has passed <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7128 | Required request part 'file' is not present <em>[Upload Mandate Document](#operation/putPdfFileUsingPOST)</em>
7129 | Debtor Bank BIC is required as Debtor Bank is located in a NON-EEA Country <em>[Create mandate](#operation/addMandateUsingPOST),[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST),[Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
7130 | Beneficiary Bank BIC is required as Beneficiary Bank is located in a NON-EEA Country <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7131 | Field is invalid or max length is exceeded <em>[Create account](#operation/addAccountUsingPOST), [List accounts](#operation/listAccountsUsingPOST), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7132 | Field is required <em>[Create account](#operation/addAccountUsingPOST)</em>
7133 | IBAN is requried if External Account Validation is off <em>[Create account](#operation/addAccountUsingPOST)</em>
7134 | Object is required <em>[Create account](#operation/addAccountUsingPOST)</em>
7135 | Object is not allowed for current Originator configuration <em>[Create account](#operation/addAccountUsingPOST)</em>
7136 | Account Validation Error <em>[Create account](#operation/addAccountUsingPOST)</em>
7137 | Account already exist <em>[Create account](#operation/addAccountUsingPOST)</em>
7138 | Currency is not supported <em>[Create account](#operation/addAccountUsingPOST)</em>
7139 | Field is required for provided Account Country <em>[Create account](#operation/addAccountUsingPOST)</em>
7140 | Field is not allowed for provided Account Country <em>[Create account](#operation/addAccountUsingPOST)</em>
7141 | Field is not allowed for current Originator configuration <em>[Create account](#operation/addAccountUsingPOST)</em>
7142 | Cannot generate account for current Originator configuration. Billing Mandate Reference is not set. <em>[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST), [Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
7149 | Master Account is type is invalid <em>[Create Account](#operation/addAccountUsingPOST)</em>
7150 | Master Account currency has to be the same as Sub-Account currency <em>[Create Account](#operation/addAccountUsingPOST)</em>
7200 | JWS-Signature header is required. <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7201 | JWS-Signature is invalid. <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7202 | Invalid file MIME Type for file extention. Please check the file content. <em>[Upload file](#operation/uploadFileUsingPOST)</em>
7204 | Value Date To is invalid. <em>[List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7205 | Value Date From is invalid. <em>[List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7206 | Amount From is invalid. <em>[List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7207 | Amount To is invalid. <em>[List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7208 | 'Value Date From' is not earlier or equal to 'Value Date To'. <em>[List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7209 | 'Amount From' is greater then 'Amount To'. <em>[List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7203 | Field is invalid or max length is exeeded <em>[List account balances](#operation/viewAccountBalancesUsingGET)</em>
7300 | UltimateParty Name' is invalid or max length is exceeded. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7301 | UltimateParty Other SchemeName Code' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7302 | UltimateParty Other SchemeName Proprietary' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7303 | UltimateParty Other ID' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7304 | UltimateParty Other Issuer' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7305 | UltimateParty OrganisationId BicorBei' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7306 | UltimateParty PrivateId BirthDate' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7307 | UltimateParty PrivateId BirthDate' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7308 | UltimateParty PrivateId CityOfBirth' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7309 | UltimateParty PrivateId CountryOfBirth' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7310 | UltimateParty PrivateId CountryOfBirth' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7330 | UltimateCreditor either 'organisationId' or 'privateId' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7331 | UltimateCreditor OrganisationId either 'bicOrBei' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7332 | UltimateCreditor OrganisationId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7333 | UltimateCreditor PrivateId either 'dateAndPlaceOfBirth' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7334 | UltimateCreditor PrivateId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7335 | UltimateDebtor either 'organisationId' or 'privateId' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7336 | UltimateDebtor OrganisationId either 'bicOrBei' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7337 | UltimateDebtor OrganisationId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7338 | UltimateDebtor PrivateId either 'dateAndPlaceOfBirth' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7339 | UltimateDebtor PrivateId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7340 | UltimateParty Other ID' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7341 | UltimateParty PrivateId CityOfBirth' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7148 | The Execution Date must be set to today's date. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7152 | Payment amount exceeds max allowed scheme limit. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7153 | Requested payment type is not supported by Originator. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7154 | Originator Bank BIC is required for EXPRESS payments. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7167 | Credit transfer not available from this account. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
8888 | Input validation errors occurred. Please check details <em>[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST),[Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
9001 | Invalid Domestic Account Number <em>[Validate Domestic Account](#operation/validateDomesticAccountUsingPOST)</em>
9002 | None-SEPA country IBAN has been provided <em>[Create mandate](#operation/addMandateUsingPOST), [Update mandate](#operation/editMandateUsingPUT)</em>
9999 | Resource validation error <em>[Create direct debit and mandate](#operation/addSinglePaymentMOTFUsingPOST),[Create payment schedule and mandate](#operation/addPaymentScheduleUsingPOST_1)</em>
10002 | Request parameters not valid <em>[Upload file](#operation/uploadFileUsingPOST)</em>
- name: Pagination
description: |-
Nuapay API utilizes offset-based pagination for endpoints returning a collection of resources.
Pagination parameters can be passed in URI for GET requests and in Body in POST requests.
To control pagination, simply include either of 'Page Number' and 'Page Size' parameters in a request. In the supported responses there will always be a page section added, describing the pagination settings used.
<aside class='notice'>
NOTE: the default value for Page Size is 20 and the maximum value you can set is 100.
</aside>
<br>
# In URI
There are two parameters that control pagination: `pagenumber`, which specifies the page number to retrieve, and `pagesize`, which indicates how many records each page should contain.
<br>
# In Body
Path | Type | Description
---- | ---- | -----------
page.pageNumber<em>required</em>| Number | Holds page number to be returned. Default: 1
page.pageSize<em>required</em>| Number | Holds page size to be returned. Default: 20
<br>
> e.g. show the 1st page with a maximum of 10 entries per page from all of the available mandates:
```bash
$ curl 'https://api.nuapay.com/schemes/46pkx7o9n5/mandates/?pagesize=10&pagenumber=1' \
-u bb09c2b6a9478720765c757a8bcadf1aa1fb31554566a21118c9c75e26c29686: \
```
``` java
ListMandatesRequestParameters listMandatesRequestParameters =
new ListMandatesRequestParameters();
listMandatesRequestParameters.setPageSize(10);
listMandatesRequestParameters.setPageNumber(1);
ListMandatesResponse listMandatesResponse =
mandateService.listMandates('46pkx7o9n5', listMandatesRequestParameters);
```
> the response will be:
``` http
HTTP/1.1 200 OK
Content-Type: application/json
{
'uri' : '/schemes/46pkx7o9n5/mandates',
'data' : [ {
'id' : '46pkxn8e9n',
'uri' : '/schemes/8g3o2yyk2w/mandates/46pkxn8e9n',
'mandateId' : 'b8b7ee91-b403-4ecb-9d98-059746dd8149',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
}, {
'id' : 'nx9kndaejm',
'uri' : '/schemes/8g3o2yyk2w/mandates/nx9kndaejm',
'mandateId' : 'a04ee152-505d-4125-b671-5c5318b53842',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
}, {
'id' : 'vw7kj9gey5',
'uri' : '/schemes/8g3o2yyk2w/mandates/vw7kj9gey5',
'mandateId' : '79839287-54d8-4fab-99cc-cf1808b7a766',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
} ],
'page' : {
'pageNumber' : 1,
'pageSize' : 3,
'totalElements' : 3,
'totalPages' : 1
},
'sort' : [ ]
}
```
- name: Current Version
description: |-
The current version of the Nuapay API is version 1.0. Changes may occur to this version of the API without a change in version number if such a change follows our backwards compatibility guidelines. Different versions will be managed via a HTTP header indicating the version of the API which the client is using.
Requests with no version number or an unmatched version number will be treated as version 1.0 requests.
- name: Backwards Compatibility
description: |-
The following changes are considered backwards compatible:
* Adding new API endpoints, new endpoints are independent,
* Adding new optional request parameters to existing API calls,
* Adding new response properties to existing API calls. You should pay particular attention to this point if you are mapping your JSON responses to another programming language construct,
* Changing of the property order in existing API responses,
* Changing the length of object IDs (object IDs will never exceed 255 characters),
* Changing the messages returned by validation or other error messages,
* Output Encoding Rules are applied to some services and will be applied to all services in the future.
- name: Changelog
description: |-
## 2018-07-27
* Introduced new 422 error codes, 7148, 7152, 7153 and 7154, for 'Create Credit Transfer' and 'Create Credit Transfer and Beneficiary' endpoints.
## 2018-06-18
* Introduced 'Credit Transfer and Beneficiary' endpoint which creates a beneficiary in Origix then a credit transfer in one action
* Introduced 'Type' to 'Create Credit Transfer' and 'Create Credit Transfer and Beneficiary' endpoints which will be used to distinguish between standard and express (instant) payments
## 2018-05-30
* Added `Transfers` object and POST 'Transfers' endpoint, allowing users with more than one Nuapay account to transfer funds between thier accounts.
## 2018-04-05
* Introduced explanation of the 'Links' array to the 'Resources' section.
## 2018-01-22
* Added `Originator GET` endpoint.
## 2017-09-14
* Added `List Credit Transfers POST` endpoint.
* Added `List Transactions` endpoint.
## 2017-10-20
* Renamed the 'Accounts' API section containing 'Validate Domestic Account' & 'Validate IBAN' to 'Validate Account'
* Introduced a new 'Accounts' section containing create, list and view account endpoints
* Introduced a new 'Balances' section containing the 'List Account Balances' endpoint
* Introduced error codes for the new 'Accounts' and 'Balances' endpoints
* Removed 'https:/' from some endpoint definitions
* Corrected the file format for the 'Generic CSV' DD file type to 'GC_SCHEME' in the 'Upload File' endpoint
* Fixed 'Webhooks Overview' link in the 'Transaction' section
* Merged the 'Authorization' section into the 'Security' section
## 2017-09-15
* Introduced a JWS-Signature section for non-repudiation to the 'Security' page.
* Restored the `Credit Transfer` and `Beneficiary` endpoints.
## 2017-09-14
* Added `Transactions` section.
* Added `View Schedule` service under `Payment Schedules` section.
## 2017-08-21
* Updated `Direct Debit Object`. Always return `links` section.
* Updated `Create Direct Debit`. Always return `links` section.
* Updated `View Direct Debit`. Always return `links` section.
* Updated `List Direct Debits`. Always return `links` section.
* Updated `Revoke Direct Debit`. Always return `links` section.
* Updated `Revoke All Direct Debits`. Always return `links` section.
* Updated `Re-present Failed Direct Debit`. Always return `links` section.
* Updated `Direct Debit Object`. Always return `rejectDetails` object.
* Updated `Create Direct Debit & Mandate`. Always return `rejectDetails` object.
* Updated `Retrieve Direct Debit`. Always return `rejectDetails` object.
* Updated `List Direct Debits`. Always return `rejectDetails` object
* Updated `Revoke Direct Debit`. Always return `rejectDetails` object
* Updated `Re-present Failed Direct Debit`. Always return `rejectDetails` object
## 2017-08-15
* Removed `E-Mandates` section as this is covered in it's own API documentation. See the [Useful Links](#useful-links) for a link to the E-Mandate API documentation.
## 2017-08-14
* Updated `Resources` section. Added more details on Resource Id.
## 2017-07-12
* Updated `Error Codes`. Added codes `7129`, `7130`.
## 2017-07-05
* Temporarily removed `Credit Transfer` and `Beneficiary` endpoints.
## 2017-05-29
* Updated `Direct Debit Object`. Removed `INVALID` Status.
## 2017-05-24
* Updated `Validate Domestic Account`. Return `domesticBranchCode` also if null
* Updated `Validate IBAN`. Return `domesticBranchCode` also if null
* Updated `Create Credit Transfer`. Always return `paymentCurrency`
* Updated `List Credit Transfers`. Always return `paymentCurrency`
* Updated `Direct Debit Object`. Always return `scheduleId` and `originalEndToEndId`
* Updated `Create Direct Debit`. Always return `scheduleId` and `originalEndToEndId`
* Updated `Create Direct Debit & Mandate`. Always return `scheduleId` and `originalEndToEndId`
* Updated `Retrieve Direct Debit`. Always return `scheduleId` and `originalEndToEndId`
* Updated `List Direct Debits`. Always return `scheduleId` and `originalEndToEndId`
* Updated `List Failed Direct Debits`. Always return `scheduleId` and `originalEndToEndId`
* Updated `Revoke Direct Debit`. Always return `scheduleId` and `originalEndToEndId`
* Updated `Re-present Failed Direct Debit`. Always return `scheduleId` and `originalEndToEndId`
* Updated `Create Schedule`. Always return `paymentDayOfWeek`,`paymentWeekOfMonth`, `paymentDateInMonth`, `paymentCustomFrequency`.
* Updated `Create Schedule & Mandate`. Always return `paymentDayOfWeek`,`paymentWeekOfMonth`, `paymentDateInMonth`, `paymentCustomFrequency`
* Updated `Upload file`. Added returned parameters `originalFileName`, `newFileName`
## 2017-04-11
* Updated `Create Payment Schedule Object`. Added `settlement date shift` property to request.
* Updated `Create Direct Debit Object`. Added `settlement date shift` property to request.
* Updated `Create Payment Schedule and Mandate`. Added `settlement date shift` property to request.
* Updated `Create Direct Debit and Mandate`. Added `settlement date shift` property to request.
* Updated `Error Codes`. Added codes `7125`, `7126`,`7127`.
* Updated `List Credit Transfers` request parameters. Added `originatoriban`.
## 2017-03-10
* Updated `List Mandates` section, removed defaults from query parameters for `createdatefrom` and `createdateto` under `List Mandates`, updated `mandatestatus` description that supports multiple statuses filtering within single request.
* Updated `Upload Mandate Document` added note on `json` request part.
* Added `Create Direct Debit and Mandate` section.
* Updated `List Direct Debits` section, removed defaults from URI parameters for `actualcollectiondatefrom` and `actualcollectiondateto`, updated `paymentstatus` description that supports multiple statuses filtering within a single request.
* Added `Create Payment Schedule and Mandate` section.
* Updated `Create Payment Schedule Object`section. `paymentScheduleStatus` property is now returned by `Create Payment Schedule` service.
* Updated `Errors` section. Extended response object section with `details` array.
* Updated `Error Codes`. Added codes `7123`, `7124`,`7128`,`8888`,`9999`.
* Updated `List Credit Transfers` section. Updated `paymentstatus` description that supports multiple statuses filtering within single request.
* Updated `Credit Transfer Object` section. `beneficiaryName`,`beneficiaryIban` property is now returned by `Create Credit Transfer` service.
## 2017-03-01
* Removed `List Beneficiary Object` from `Beneficiaries` section. `List Beneficiaries` service returns `Beneficiary Object` at the moment.
* Added `List Credit Transfers` service description to `Credit Transfers` section.
* Updated `Payment Schedule Object`, `twoPaymentsSamePeriod` property description.
## 2017-01-10
* Updated `List Mandates` section. Additional details added to description of `createdatefrom` parameter.
* Updated `paymentAmount`property description across different sections. Added details of decimal separator and decimal places.
* Added `Credit Transfers` section.
* Updated `Payment Schedule` section with `List Payment Schedules` and `Cancel Payment Schedule`. Additional details added to `Payment Schedule Object` including new response only property and description of amount fields.
* Updated `Error Codes` section. Added codes 7111-7120. Fixed description for code 7103.
* Updated `Direct Debits` section. Additional details added to description of `actualcollectiondatefrom` and `actualcollectiondateto` parameters.
* Added description of `List Mandate Object`.
* Updated `Update Mandate` section with more details on service behaviour.
* Removed reference to `COR1` Scheme Type as it is not supported anymore.
* Update to `Definition` sections across different enpoints. More consistent method and resource URI presentation.
## 2016-07-20
* Fixed an error in the e-mandate signature URL, corrected URL should read, https://api.nuapay.com/emandate/web/show?token=XXXX
## 2016-06-29
* Some additional existing error codes can now affect the `Prepare E-Mandate` service depending on configuration, see `Error Codes` section for details.
## 2016-05-06
* Updated a number of examples using the -curl command, moving parameters using `-d` into the URL.
* Added a `Useful Links` section with links to other relevant Nuapay integration documents.
## 2016-04-12
* Updated Mandate Object `mandateInfo.status` and List Mandate `mandatestatus` with READY_FOR_EXPORT and EXPORTED status.
## 2016-04-11
* Removed `v1` from endpoints
## 2016-04-03
* Added `Versioning` section.
* Updated request URI's based on versioning.
## 2016-01-21
* Added `Security` section,
* Added `Upload mandate document` service under `Mandates` section.
* Added `E-Mandate Signature URLs` under `E-Mandates` section.
* Updated `Error Codes` section. Added codes 7102 - 7110.
## 2015-11-19
* Added `E-Mandates` section.
* Fix for `List Direct Debits` request parameters.
* Updated `scheduleId` property to `String`.
* Added `Beneficiary list` object.
* Added `mandateInfo.status` and `mandateInfo.creationDate` to `Mandate` object.
* Added `Failed Direct Debit` object.
* Added [NuaPay Java Rest Client](https://github.com/sentenial/nuapay-rest-client) lib examples.
## 2015-09-30
* Added `Beneficiaries` section.
* Updated `Add Payment Schedule` object. The payment schedule supports now `CUSTOM` frequency. New `paymentCustomFrequency` and `twoPaymentsSamePeriod` properties added.
* Updated `Mandate` object. Added supported `language` property values.
* Updated `Error Codes` section. Added codes 7078-7089, 7098-7101.
* Updated `Accounts` section. New `Validate IBAN` service added. Defined `Account` object.
* Added `Backwards Compatibility` section.
## 2015-09-01
* API public release.
x-tagGroups:
- name: Generial Info
tags:
- Introduction
- Getting Started
- API Endpoints
- name: Security
tags:
- Authentication
- Output Encoding Rules
- JWS-Signature Header
- name: Resources
tags:
- Returned Resources
- Resource IDs
- Links
- name: Direct Debits APIs
tags:
- Creditor Schemes
- Mandates
- Direct Debits
- Payment Schedules
- name: Credit Transfers APIs
tags:
- Beneficiaries
- Credit Transfers
- name: Nuapay Accounts APIs
tags:
- Accounts
- Balances
- Transactions
- Transaction Types
- Transfers
- name: Other APIs
tags:
- Files
- Validate Accounts
- Other
- name: Responses
tags:
- About Responses
- HTTP Status Codes
- Errors
- Error Codes
- Pagination
- name: Versioning
tags:
- Current Version
- Backwards Compatibility
- name: Change log
tags:
- Changelog
schemes:
- http
paths:
/accounts:
post:
tags:
- Accounts
summary: Create Account
description: |-
POST request used to register or create account depending on the Originator configuration. A request must contain the application/json content type.
Important Note: The 'identification' parameter and associated sub-parameters should be used only when creating a non-Nuapay account.
operationId: addAccountUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- in: body
name: addAccountRequest
description: addAccountRequest
required: true
schema:
$ref: '#/definitions/AddAccountRequest'
responses:
201:
description: Created
schema:
$ref: '#/definitions/RestResponseEnvelopeOfAccountResponseEntity'
examples:
application/json:
uri: /accounts/6bee3razby
data:
id: 6bee3razby
uri: /accounts/6bee3razby
name: Test Account
currency: EUR
type: CURRENT_ACCOUNT
identification:
iban: GB35SELN00999903769154
domesticAccountNumber: '03769154'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: GENODESELNGB21XXXF1P17
secondaryIdentification: REST ACC
links: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7131'
field: type
description: Field is invalid or max length is exceeded
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '9999'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7075'
field: identification.domesticAccountNumber
description: Domestic Account Number is required if IBAN is not provided
resourceUri: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/list:
post:
tags:
- Accounts
summary: List Accounts
description: |-
POST request used to retrieve a list of accounts in a secured way. Query parameters are passed in the JSON body object. A request must contain the application/json content type.
Important Note: Since this is a POST endpoint with only optional parameters when not providing any parameters user must supply an empty JSON body using {}.
operationId: listAccountsUsingPOST
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- in: body
name: listAccountRequest
description: listAccountRequest
required: true
schema:
$ref: '#/definitions/ListAccountRequestEntity'
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfAccountResponseEntity'
examples:
application/json:
uri: /accounts/list
data:
- id: 6bee3razby
uri: /accounts/6bee3razby
name: Test Account
currency: EUR
type: CURRENT_ACCOUNT
identification:
iban: GB35SELN00999903769154
domesticAccountNumber: '03769154'
domesticBankCode: null
domesticBranchCode: 009999
domesticAccountChecksum: null
domesticAccountCountry: GB
bic: SELNGB21XXX
secondaryIdentification: REST ACC
links: []
page:
pageNumber: 1
pageSize: 10
totalElements: 1
totalPages: 1
sort: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7131'
field: filter.queryString
description: Field is invalid or max length is exceeded
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7201'
returnDescription: JWS-Signature is invalid.
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '9999'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7051'
field: page.pageSize
description: Max page size is exceeded
resourceUri: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/{accountId}:
get:
tags:
- Accounts
summary: View Account
description: GET request used to retrieve a patricular account object identified by resource ID returned by Create or List Accounts services.
operationId: viewAccountUsingGET
produces:
- application/json
parameters:
- name: accountId
in: path
description: Encoded Account ID of the account to be viewed.
required: true
type: string
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestResponseEnvelopeOfAccountResponseEntity'
examples:
application/json:
uri: /account/6bee3razby
data:
id: 6bee3razby
uri: /account/6bee3razby
name: Test Account
currency: EUR
type: CURRENT_ACCOUNT
identification:
iban: GB35SELN00999903769154
domesticAccountNumber: '03769154'
domesticBankCode: null
domesticBranchCode: 009999
domesticAccountChecksum: null
domesticAccountCountry: GB
bic: SELNGB21
secondaryIdentification: '12REST ACC345'
links: []
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/{accountId}/subaccounts/list:
post:
tags:
- Accounts
summary: List Sub-Accounts for Master Account
description: |-
POST request used to retrieve a list of sub-accounts for master account in a secured way. Query parameters are passed in the JSON body object. A request must contain the application/json content type.
Important Note: Since this is a POST endpoint with only optional parameters when not providing any parameters user must supply an empty JSON body using {}.
operationId: listSubAccountsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- name: accountId
in: path
description: accountId
required: true
type: string
- in: body
name: listAccountRequest
description: listAccountRequest
required: true
schema:
$ref: '#/definitions/ListAccountRequestEntity'
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfAccountResponseEntity'
examples:
application/json:
uri: /accounts/6bee3razby/subaccounts/list
data:
- id: 6bee3razby
uri: /accounts/6bee3razby
name: Test Account
currency: EUR
type: SUB_ACCOUNT
identification:
iban: GB35SELN00999903769154
domesticAccountNumber: '03769154'
domesticBankCode: null
domesticBranchCode: 009999
domesticAccountChecksum: null
domesticAccountCountry: GB
bic: SELNGB21XXX
secondaryIdentification: REST ACC
links: []
page:
pageNumber: 1
pageSize: 10
totalElements: 1
totalPages: 1
sort: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7131'
field: filter.queryString
description: Field is invalid or max length is exceeded
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7201'
returnDescription: JWS-Signature is invalid.
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '9999'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7051'
field: page.pageSize
description: Max page size is exceeded
resourceUri: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/{accountId}/balances:
get:
tags:
- Balances
summary: List Account Balances
description: A GET request is used to retrieve patricular account balances
operationId: viewAccountBalancesUsingGET
produces:
- application/json
parameters:
- name: accountId
in: path
description: Encoded account id of the account whos balances are to be viewed.
required: true
type: string
- name: dateuntil
in: query
description: 'Epoch timestamp format date until which the balance should be returned. Default: current date.'
required: false
type: integer
format: int64
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestCollectionResponseEnvelopeOfListAccountBalanceResponseEntity'
examples:
application/json:
uri: /accounts/rmpa5ve4m6/balances
data:
- uri: /accounts/rmpa5ve4m6/balances
balance:
amount: 1000
currency: EUR
creditDebitIndicator: CREDIT
type: BOOKED_BALANCE
timestamp: '1513083481996'
links: []
- uri: /accounts/rmpa5ve4m6/balances
balance:
amount: 1000
currency: EUR
creditDebitIndicator: CREDIT
type: AVAILABLE_BALANCE
timestamp: '1513083481996'
links: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: Input validation errors occurred. Please check details.
details:
code: '7131'
field: dateuntil
description: Field is invalid or max length is exceeded
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/{accountId}/credittransfers/list:
post:
tags:
- Accounts
summary: List Credit Transfers for Account
description: |-
A POST request used to retrieve a list of credit transfers for a given account in secured way. Request parameters to be passed in the JSON body object.
A request must contain the application/json content type.
Important Note: Since this is a POST endpoint with only optional parameters when not providing any parameters user must supply an empty JSON body using {}.
operationId: listCreditTransfersForAccountUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- name: accountId
in: path
description: Encoded Account Id of the account to list credit transfers from.
required: true
type: string
- in: body
name: listCreditTransfersAccountRequest
description: listCreditTransfersAccountRequest
required: true
schema:
$ref: '#/definitions/ListCreditTransferPostRequestEntity'
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfCreditTransferResponseEntity'
examples:
application/json:
uri: /accounts/w24y3dya2p/credittransfers/list
data:
- id: j29pjrvdbx
uri: /beneficiaries/j29pjqknbx/credittransfers/j29pjrvdbx
originatorIban: GB25SELN00999988796624
originatorAccount:
iban: GB25SELN00999988796624
bic: SELNGB21
domesticAccountNumber: '88796624'
domesticBankCode: null
domesticBranchCode': '009999'
domesticCheckSum: null
domesticAccountCountry: GB
requestedExecutionDate: "2018-10-27"
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: '563456456'
remittanceInformation: Remittance info
paymentStatus: ACCEPTED
type: STANDARD
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links: []
page:
pageNumber: 1
pageSize: 1
totalElements: 1
totalPages: 1
sort: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: Input validation errors occurred. Please check details.
details:
-
code: '7001'
field: 'filter.executionDateFrom'
description: Date format invalid
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '9999'
returnDescription: 'Input validation errors occurred. Please check details.'
details:
-
code: '7002'
description: "'From Date' must be earlier or equal to 'To Date'"
resourceUri: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/{accountId}/transactions/list:
post:
tags:
- Transactions
summary: List Transactions
description: |-
POST request used to retrieve a list of Transactions associated to an account.
Important note: Since this is a POST endpoint with only optional parameters when not providing any parameters user must supply an empty JSON body using {}.
operationId: listTransactionsUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- name: accountId
in: path
description: Encoded Account Id of the account whos transactions are to be viewed.
required: true
type: string
- in: body
name: request
description: request
required: true
schema:
$ref: '#/definitions/ListAccountTransactionsRequest'
responses:
200:
description: OK
schema:
$ref: '#/definitions/ListAccountTransactionsResponse'
examples:
application/json:
uri: /accounts/w24y3dzo2p/transactions/
data:
id: bzja3ye692
uri: /accounts/w24y3dzo2p/transactions/bzja3ye692
postingDate: '2018-02-07'
transactionType: OUTGOING_CREDIT_TRANSFER
valueDate: '2018-02-07'
amount: 1
currency: EUR
creditDebitIndicator: DEBIT
purposeCode: null
endToEndId: endToEndId1
mandateReference: null
ultimateCreditorId: null
ultimateCreditorName: null
ultimateDebtorId: null
ultimateDebtorName: null
reasonCode: null
reasonProprietary: null
bulkMessageId: null
batchReference: null
unstructuredRemittanceInformation: null
remittanceInfo: remittanceInfo
schemeType: null
numberOfTransactions: null
totalAmount: null
balanceAfterTransaction:
amount: 23781.16
currency: EUR
creditDebitIndicator: CREDIT
type: BOOKED_BALANCE
counterparty:
name: Originator Name
address:
line1: Originator Address Line1
line2: Originator Address Line2
postalCode: '123123'
town: Originator Town
country: PL
account:
iban: GB89SELN00999940483361
bic: SELNGB21
domesticAccountCountry: null
domesticAccountNumber: null
domesticBankCode: null
domesticBranchCode: null
domesticCheckSum: null
links: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: Input validation errors occurred. Please check details.
details:
code: 7052
field: page.pageSize
description: Page size is invalid
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7208'
returnDescription: "Value Date From' must be earlier or equal to 'Value Date To'"
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/accounts/{accountId}/transactions/{transactionId}:
get:
tags:
- Transactions
description: |-
GET request used to retrieve a transaction.
summary: Retrieve transaction
operationId: viewTransactionUsingGET
produces:
- application/json
parameters:
- name: accountId
in: path
description: accountId
required: true
type: string
- name: transactionId
in: path
description: transactionId
required: true
type: string
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestResponseEnvelopeOfViewAccountTransactionResponse'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
x-sentenial:
enriched: true
security:
- OriginatorApiKey: []
- OriginatorOAuth2: []
/beneficiaries:
get:
tags:
- Beneficiaries
summary: List Beneficiaries
description: A GET request used to retrieve a collection of beneficiaries. It can return beneficiaries associated to an organization.
operationId: listBeneficiariesUsingGET
produces:
- application/json
parameters:
- name: beneficiaryiban
in: query
required: false
type: string
pattern: '[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
description: Beneficiary IBAN.
- name: beneficiaryname
in: query
required: false
type: string
description: Name of Beneficiary. Used to filter credit transfers with provided beneficiary name, full and partial names are supported.
maxLength: 70
- name: orderby
in: query
required: false
type: string
- name: pagenumber
in: query
required: false
type: integer
format: int32
description: 'Holds page number to be returned. Default: 1'
default: 1
- name: pagesize
in: query
required: false
type: integer
format: int32
description: 'Holds page size to be returned. Default: 20'
default: 20
- name: usercreatedbeneficiary
in: query
required: false
type: boolean
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfListBeneficiaryResponseEntity'
examples:
application/json:
uri: /beneficiaries
data:
- id: w24y3olz2p
uri: /beneficiaries/w24y3olz2p
beneficiary:
name: Beneficiary Name
address:
line1: Beneficiary Address Line1
line2: Beneficiary Address Line2
town: Beneficiary Town
postCode: '123123'
state: Beneficiary State
country: IE
language: en
email: beneficiary@mail.com
mobileNumber: '0360321321321'
phoneNumber: '0360123123123'
descriptionOfPurpose: Description of Purpose
beneficiaryAccount:
iban: GB47SELN00999912345678
bic: SELNGB21
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
- id: abxq9jak2l
uri: /beneficiaries/abxq9jak2l
beneficiary:
name: Beneficiary Name
address:
line1: Beneficiary Address Line1
line2: Beneficiary Address Line2
town: Beneficiary Town
postCode: '123123'
state: Beneficiary State
country: IE
language: en
email: beneficiary@mail.com
mobileNumber: '0360321321321'
phoneNumber: '0360123123123'
descriptionOfPurpose: Description of Purpose
beneficiaryAccount:
iban: GB47SELN00999912345678
bic: SELNGB21
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
page:
pageNumber: 1
pageSize: 20
totalElements: 2
totalPages: 1
sort: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7100'
returnDescription: Beneficiary Name is invalid or max length is exceeded
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7051'
returnDescription: Max page size is exceeded
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
post:
tags:
- Beneficiaries
summary: Create Beneficiary
description: A POST request used to create beneficiaries. The request must contain the application/json content type. In the request body you must provide a JSON structure describing the Beneficiary.
operationId: addBeneficiaryUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: true
type: string
- in: body
name: addBeneficiaryRequest
description: |-
Note: For the beneficiary account information use either IBAN & BIC or Domestic Account details, not both.
required: true
schema:
$ref: '#/definitions/AddBeneficiaryRequestEntity'
responses:
201:
description: Created
schema:
$ref: '#/definitions/RestResponseEnvelopeOfAddBeneficiaryResponseEntity'
examples:
application/json:
uri: /beneficiaries/46pkx7o9n5
data:
id: 46pkx7o9n5
uri: /beneficiaries/46pkx7o9n5
beneficiary:
name: Beneficiary Name
address:
line1: Beneficiary Address Line1
line2: Beneficiary Address Line2
town: Beneficiary Town
postCode: '123123'
state: Beneficiary State
country: IE
language: en
email: beneficiary@mail.com
mobileNumber: '0360321321321'
phoneNumber: '0360123123123'
descriptionOfPurpose: Description of Purpose
beneficiaryAccount:
iban: GB47SELN00999912345678
bic: SELNGB21
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
links: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7081'
returnDescription: Beneficiary IBAN is invalid
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7201'
returnDescription: JWS-Signature is invalid.
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7159'
returnDescription: Either Iban or Domestic Account is allowed.
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/beneficiaries/{beneficiaryId}:
get:
tags:
- Beneficiaries
summary: Retrieve Beneficiary
description: A GET request used to retrieve a beneficiary.
operationId: viewBeneficiaryUsingGET
produces:
- application/json
parameters:
- name: beneficiaryId
in: path
description: Encoded Beneficiary ID of the beneficiary to be viewed.
required: true
type: string
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestResponseEnvelopeOfViewBeneficiaryResponseEntity'
examples:
application/json:
uri: /beneficiaries/46pkx7o9n5
data:
id: 46pkx7o9n5
uri: /beneficiaries/46pkx7o9n5
beneficiary:
name: Beneficiary Name
address:
line1: Beneficiary Address Line1
line2: Beneficiary Address Line2
town: Beneficiary Town
postCode: '123123'
state: Beneficiary State
country: IE
language: en
email: beneficiary@mail.com
mobileNumber: '0360321321321'
phoneNumber: '0360123123123'
descriptionOfPurpose: Description of Purpose
beneficiaryAccount:
iban: GB47SELN00999912345678
bic: SELNGB21
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
links: []
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/beneficiaries/{beneficiaryId}/credittransfers:
get:
tags:
- Credit Transfers
summary: List Beneficiary Credit Transfers
description: A GET request used to retrieve a collection of credit transfers. This request can be used to list all credit transfers associated to a beneficiary.
operationId: listCreditTransfersBeneficiaryUsingGET
produces:
- application/json
parameters:
- name: beneficiaryId
in: path
description: Encoded Beneficiary ID of the beneficiary whos credit transfers are to be viewed.
required: true
type: string
- name: beneficiaryiban
in: query
required: false
type: string
pattern: '[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
description: Used to filter credit transfers by provided beneficiary IBAN.
- name: beneficiaryname
in: query
required: false
type: string
description: Used to filter credit transfers by provided beneficiary name. Full and partial name supported.
maxLength: 70
- name: executiondatefrom
in: query
required: false
type: string
format: date
description: Returns CTs to be executed from this date. Fromat yyyy-mm-dd.
- name: executiondateto
in: query
required: false
type: string
format: date
description: Returns CTs to be executed to this date. Fromat yyyy-mm-dd.
- name: orderby
in: query
required: false
type: string
description: Order query by, default 'id' in descending order.
- name: originatoriban
in: query
required: false
type: string
pattern: '[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
description: Used to filter credit transfers by provided originator IBAN.
- name: pagenumber
in: query
required: false
type: integer
format: int32
description: 'Holds page number to be returned. Default: 1'
default: 1
- name: pagesize
in: query
required: false
type: integer
format: int32
description: 'Holds page size to be returned. Default: 20'
default: 20
- name: paymentstatus
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
enum:
- ALL
- READY_FOR_EXPORT
- REJECTED
- RECALLED
- EXPORTED
- ACCEPTED
- PENDING
- PENDING_SETTLEMENT
description: A number of statuses can be queried within a single request by providing multiple occurences of the parameter.
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfCreditTransferResponseEntity'
examples:
application/json:
uri: /beneficiaries/abxq9ox92l/credittransfers
data:
- id: a2av38kz2w
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: 'GB94SELN00999976543215'
bic: 'SELNGB21'
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: 'GB'
requestedExecutionDate: '2016-10-14'
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: 12345678901330w4
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: EXPRESS
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
- id: j29p3gkabx
uri: /beneficiaries/abxq9ox92l/credittransfers/j29p3gkabx
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: 'GB94SELN00999976543215'
bic: 'SELNGB21'
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: 'GB'
requestedExecutionDate: '2016-10-14'
paymentAmount: 1.01
paymentCurrency: EUR
endToEndId: abcdefghij1234
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: STANDARD
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
page:
pageNumber: 1
totalPages: 1
pageSize: 20
totalElements: 2
sort: []
202:
description: Accepted
headers:
Location:
type: string
description: Uri to approval'
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7001'
returnDescription: Date format invalid
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7002'
returnDescription: "'From Date' must be earlier or equal to 'To Date'"
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
post:
tags:
- Credit Transfers
summary: Create Credit Transfer
description: A POST request used to create credit transfers. A request must contain the application/json content type. In the request body you must provide a JSON structure describing the Credit Transfer.
operationId: addCreditTransferUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: true
type: string
- name: Dynamic-Link-Id
in: header
description: Optional header used to provide additional information for SCA.
required: false
type: string
- in: body
name: addCreditTransferRequest
description: addCreditTransferRequest
required: true
schema:
$ref: '#/definitions/AddCreditTransferRequestEntity'
- name: beneficiaryId
in: path
description: Encoded Beneficiary ID of the beneficiary to add a credit transfer against.
required: true
type: string
responses:
201:
description: Createdd
schema:
$ref: '#/definitions/RestResponseEnvelopeOfCreditTransferResponseEntity'
examples:
application/json:
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
data:
id: a2av38kz2w
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: 'GB94SELN00999976543215'
bic: 'SELNGB21'
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: 'GB'
requestedExecutionDate: '2016-10-14'
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: 12345678901330w4
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: EXPRESS
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '5009'
returnDescription: Invalid Date for Payment
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
412:
description: Precondition Failed
headers:
Dynamic-Link-Id:
description: Dynamic Link Id
type: string
Authorisation-Uri:
description: Authorisation Uri
type: string
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '5008'
returnDescription: Invalid Payment Reference
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/beneficiaries/{beneficiaryId}/credittransfers/{creditTransferId}:
get:
tags:
- Credit Transfers
summary: Retrieve Credit Transfer
description: A GET request used to retrieve credit transfers.
operationId: viewCreditTransferUsingGET
produces:
- application/json
parameters:
- name: beneficiaryId
in: path
description: Encoded Beneficiary ID of the beneficiary the credit transfer is associated to.
required: true
type: string
- name: creditTransferId
in: path
description: Encoded Credit Transfer ID of the credit transfer to be viewed.
required: true
type: string
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestResponseEnvelopeOfCreditTransferResponseEntity'
examples:
application/json:
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
data:
id: a2av38kz2w
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: 'GB94SELN00999976543215'
bic: 'SELNGB21'
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: 'GB'
requestedExecutionDate: '2016-10-14'
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: 12345678901330w4
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: EXPRESS
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/credittransfers:
get:
tags:
- Credit Transfers
summary: List Originator Credit Transfers
description: A GET request used to retrieve a collection of credit transfers. This request can be used to list all credit transfers associated to an originator.
operationId: listCreditTransfersUsingGET
produces:
- application/json
parameters:
- name: beneficiaryiban
in: query
required: false
type: string
pattern: '[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
description: Used to filter credit transfers by provided beneficiary IBAN.
- name: beneficiaryname
in: query
required: false
type: string
description: Used to filter credit transfers by provided beneficiary name. Full and partial name supported.
maxLength: 70
- name: executiondatefrom
in: query
required: false
type: string
format: date
description: Returns CTs to be executed from this date. Fromat yyyy-mm-dd.
- name: executiondateto
in: query
required: false
type: string
format: date
description: Returns CTs to be executed to this date. Fromat yyyy-mm-dd.
- name: orderby
in: query
required: false
type: string
description: Order query by, default 'id' in descending order.
- name: originatoriban
in: query
required: false
type: string
pattern: '[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
description: Used to filter credit transfers by provided originator IBAN.
- name: pagenumber
in: query
required: false
type: integer
format: int32
description: 'Holds page number to be returned. Default: 1'
default: 1
- name: pagesize
in: query
required: false
type: integer
format: int32
description: 'Holds page size to be returned. Default: 20'
default: 20
- name: paymentstatus
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
enum:
- ALL
- READY_FOR_EXPORT
- REJECTED
- RECALLED
- EXPORTED
- ACCEPTED
- PENDING
- PENDING_SETTLEMENT
description: A number of statuses can be queried within a single request by providing multiple occurences of the parameter.
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfCreditTransferResponseEntity'
examples:
application/json:
uri: /credittransfers
data:
- id: a2av38kz2w
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: 'GB94SELN00999976543215'
bic: 'SELNGB21'
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: 'GB'
requestedExecutionDate: '2016-10-14'
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: 12345678901330w4
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: EXPRESS
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
- id: j29p3gkabx
uri: /beneficiaries/abxq9ox92l/credittransfers/j29p3gkabx
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: 'GB94SELN00999976543215'
bic: 'SELNGB21'
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: 'GB'
requestedExecutionDate: '2016-10-14'
paymentAmount: 1.01
paymentCurrency: EUR
endToEndId: abcdefghij1234
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: STANDARD
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
page:
pageNumber: 1
totalPages: 1
pageSize: 20
totalElements: 2
sort: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7001'
returnDescription: Date format invalid
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7002'
returnDescription: "'From Date' must be earlier or equal to 'To Date'"
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
post:
tags:
- Credit Transfers
summary: Create Credit Transfer and Beneficiary
description: A POST request used to a create credit transfers and beneficiary if none exists. A request must contain the application/json content type. In the request body you must provide a JSON structure describing the Credit Transfer and Beneficiary.
operationId: addCTBeneficiaryOnFlyUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: The header contains JWS Signature of payload body signed with Private Key of the Sender. The PKI Key pair generation with Developer Dashboard is prerequisite for the Signature Generation.
required: true
type: string
- name: Dynamic-Link-Id
in: header
description: Optional header used to provide additional information for SCA.
required: false
type: string
- in: body
name: addCTBeneficiaryOnFlyRequest
description: addCTBeneficiaryOnFlyRequest
required: true
schema:
$ref: '#/definitions/AddCreditTransferAndBeneficiaryRequestEntity'
responses:
201:
description: Created
schema:
$ref: '#/definitions/RestResponseEnvelopeOfCreditTransferResponseEntity'
examples:
application/json:
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
data:
id: a2av38kz2w
uri: /beneficiaries/abxq9ox92l/credittransfers/a2av38kz2w
originatorIban: GB94SELN00999976543215
originatorAccount:
iban: GB94SELN00999976543215
bic: SELNGB21
domesticAccountNumber: '76543215'
domesticBankCode: null
domesticBranchCode: '009999'
domesticCheckSum: null
domesticAccountCountry: GB
requestedExecutionDate: '2016-10-14'
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: 12345678901330w4
remittanceInformation: Remittance info
paymentStatus: READY_FOR_EXPORT
type: STANDARD
paymentScheme: SCT
ultimateCreditor:
name: ultimate Creditor
organisationId:
bicOrBei: SELNGB21
other: null
privateId: null
ultimateDebtor:
name: ultimate Debtor
organisationId: null
privateId:
dateAndPlaceOfBirth:
birthDate: '2000-05-09'
cityOfBirth: city
countryOfBirth: IE
other: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: '12345678'
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
links:
- resourceType: beneficiary
id: abxqg83n2l
uri: /beneficiaries/abxqg83n2l
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: 'Input validation errors occurred. Please check details.'
details:
code: '5009'
field: 'requestedExecutionDate'
description: 'Invalid Date for Payment'
resourceUri: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
404:
description: Not Found
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10093'
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
412:
description: Precondition Failed
headers:
Dynamic-Link-Id:
description: Dynamic Link Id
type: string
Authorisation-Uri:
description: Authorisation Uri
type: string
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '8888'
returnDescription: 'Input validation errors occurred. Please check details.'
details:
code: '5007'
field: originatorIban
description: 'Originator Account provided does not exist'
resourceUri: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/directdebits:
get:
tags:
- Direct Debits
summary: List Originator Direct Debits
description: A GET request is used to retrieve collection of direct debits. Lists all direct debits associated to an originator.
operationId: listDirectDebitsOrganizationUsingGET
produces:
- application/json
parameters:
- name: actualcollectiondatefrom
in: query
required: false
type: string
format: date
description: Actual Collection Date From, Format yyyy-mm-dd.
- name: actualcollectiondateto
in: query
required: false
type: string
format: date
description: Actual Collection Date To, Format yyyy-mm-dd.
- name: orderby
in: query
required: false
type: string
description: Order query by, default 'id' in descending order.
- name: pagenumber
in: query
required: false
type: integer
format: int32
description: 'Holds page number to be returned. Default: 1'
default: 1
- name: pagesize
in: query
required: false
type: integer
format: int32
description: 'Holds page size to be returned. Default: 20'
default: 20
- name: paymentstatus
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
enum:
- ALL
- READY_FOR_EXPORT
- EXPORTING
- REVOKED
- EXPORTED
- ACCEPTED
- REVERSED
- REFUSED
- REJECTED
- RETURNED
- REFUNDED
- CANCELLED
- PENDING
- REPRESENTED
description: A number of statuses can be queried within single request by providing multiple occurance of the parameter.
- name: scheduleid
in: query
required: false
type: string
maxLength: 19
description: The Payment Schedule ID of a specific DD. Used to filter direct debits under particular Payment Schedule
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestPaginatedCollectionResponseEnvelopeOfListDirectDebitResponseEntity'
examples:
application/json:
uri: /schemes/abxq9kq52l/mandates/w24y3dya2p/directdebits
data:
- id: j29p3kpabx
uri: /schemes/abxq9kq52l/mandates/w24y3dya2p/directdebits/j29p3kpabx
scheduleId: null
endToEndId: '1234567876543234567'
paymentAmount: 5000.01
requestedCollectionDate: '2015-08-12'
actualCollectionDate: '2015-08-12'
exportDate: '2015-08-05'
remittanceInformation: Remittance Information
originalEndToEndId: null
representationAttemptNumber: 0
paymentStatus: READY_FOR_EXPORT
rejectDetails:
rejectReason: null
rejectDescription: null
rejectType: null
rejectDate: null
links:
- resourceType: mandate
id: w24y3dya2p
uri: /schemes/abxq9kq52l/mandates/w24y3dya2p
- resourceType: scheme
id: abxq9kq52l
uri: /schemes/abxq9kq52l
page:
pageNumber: 1
pageSize: 20
totalElements: 1
totalPages: 1
sort: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7001'
returnDescription: paymentstatus is invalid
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7002'
returnDescription: "'From Date' must be earlier or equal to 'To Date'"
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/faileddirectdebits:
get:
tags:
- Direct Debits
summary: List Failed Direct Debits
description: A GET request used to list failed direct debits.
operationId: listFailedDirectDebitUsingGET
produces:
- application/json
parameters:
- name: rejectcreatefrom
in: query
required: true
type: string
format: date
description: Direct Debit rejected from. In format, 'yyyy-mm-dd'. The maximum date rang is 30 days.
- name: rejectcreateto
in: query
required: true
type: string
format: date
description: Direct Debit rejected to. In format, 'yyyy-mm-dd'. The maximum date rang is 30 days.
- name: technicalrejects
in: query
required: false
type: boolean
description: Where false returns only bank rejections and true returns all rejections including OCX rejections and file import rejections.
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestCollectionResponseEnvelopeOfFailedDirectDebitResponse'
examples:
application/json:
uri: /faileddirectdebits
data:
- id: a2rexqrdmq
uri: /schemes/abxq93kk2l/mandates/wbv7x6zvb7/directdebits/a2rexqrdmq
creditorScheme:
schemeType: CORE
creditorSchemeId: '1234'
mandateInfo:
mandateId: MAND000050851137B
domesticMandateId: null
directDebitInfo:
endToEndId: e2eId
scheduleId: null
paymentAmount: 456
requestedCollectionDate: '2017-06-13'
actualCollectionDate: '2017-06-13'
exportDate: '2017-06-12'
remittanceInfo: null
originalEndToEndId: null
representationAttemptNumber: 0
paymentStatus: REJECTED
rejectDetails:
rejectReason: MD07
rejectDescription: Debtor deceased.
rejectType: Reject
rejectDate: '2017-09-12'
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7002'
returnDescription: "'From Date ' must be earlier or equal to 'To Date'"
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7003'
returnDescription: 'Max date range is exceeded'
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/files:
post:
tags:
- Files
summary: Upload file
description: POST request used to upload a file. A request must contain the multipart/form-data content type with a json part containing input parameters in a JSON structure and a file part with file content.
operationId: uploadFileUsingPOST
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- name: file
in: formData
description: file
required: true
type: file
- name: json
in: query
description: json
required: true
type: string
responses:
201:
description: Created
schema:
$ref: '#/definitions/UploadFileResponse'
examples:
application/json:
uri: /files/abxq98pn2l
data:
id: abxq98pn2l
uri: /files/abxq98pn2l
originalFileName: Sample_Pain008_AA_001.xml
newFileName: DD_GB86ZZZSDDSELN00000072112856048_CORE_P812_hgZ_Sample_Pain008_AA_001.xml.QUEUED
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7005'
returnDescription: Max file size exceeded.
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7201'
returnDescription: JWS-Signature is invalid.
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7007'
returnDescription: Not allowed file format
details: null
security:
- OriginatorOAuth2: []
- OriginatorApiKey: []
/iban/validate:
post:
tags:
- Validate Accounts
summary: Validate Accounts
description: |-
POST request used to validate accounts. A request must contain the application/json content type.
To validate an account via IBAN provide the IBAN only.
To validate a domestic account provide the relevant domestic account details.
operationId: validateDomesticAccountUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
type: string
- in: body
name: validationRequest
description: validationRequest
required: true
schema:
$ref: '#/definitions/AccountValidationRestEntity'
responses:
200:
description: OK
schema:
$ref: '#/definitions/RestResponseEnvelopeOfAccountValidationResponseRestEntity'
examples:
application/json:
uri: /iban/validate
data:
uri: /iban/validate
iban: GB35SELN00999903769154
domesticAccountNumber: '03769154'
accountCountry: GB
domesticBankCode: null
domesticBranchCode: 009999
domesticCheckSum: null
bic: SELNGB21XXX
links: []
400:
description: Bad request
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '7098'
returnDescription: Invalid IBAN
details: null
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: '10091'
returnDescription: Access denied
details: null
405:
description: Method Not Allowed
schema:
$ref: '#/definitions/ErrorResponse'
examples:
application/json:
returnCode: null
returnDescription: null