general
Overview
Payment Initiation API aims to make payment providers as simple as a cURL.
Integrations
The Salt Edge platform is incredibly easy to integrate with. We’ve built the Salt Edge Connect interface so your application could start executing payments.
Formats
We use JSON for all the requests and responses, including the errors.
Glossary
Most of the API revolves around several important concepts:
- Customer - an end-user of the client who is consuming Payment Initiation API;
- Provider - a bank or an online payment system;
- Payment - a payment that was made using Payment Initiation API.
Quick Start
Before we proceed, make sure you have a Client account or you should create one on the Sign Up page.
Any request to Payment Initiation API is authenticated, so before we are able to fetch any data we need to create API keys.
To do that, visit Keys and Secrets and create a Service API key. You can leave the
“Public key” field blank.
Providers that support payments require a provider key in order to be used. To create one, visit Provider Keys.
Note: only providers that have available payment templates support payments execution.
Each request to API is authenticated with an App-id, and a Secret. Let’s store them as environment variables so that all the later requests are authenticated.
$ export APP_ID=YOUR_APP_ID
$ export SECRET=YOUR_APP_SECRET
Create customer
Before we can create any payments, we need to create a Customer. A Customer in Payment Initiation API is the end-user of your application.
We need to save the Customer id (in this case “222222222222222222”), because we will use it later to create payments.
See customers reference for Customer related API endpoints.
URL
https://www.saltedge.com/api/payments/v1/customers
https://www.saltedge.com/api/payments/v1/customers
Method
POST
Sample Request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"identifier\": \"test1\" \
} \
}" \
https://www.saltedge.com/api/payments/v1/customerscurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"identifier\": \"test1\" \
} \
}" \
https://www.saltedge.com/api/payments/v1/customersSample Response
{
"data": {
"id": "222222222222222222",
"identifier": "test1",
"secret": "SECRET"
}
}
$ export CUSTOMER_ID=222222222222222222
Choose provider
Firstly, we need to choose a provider that supports payments and has client provider keys. We need to execute a request.
The response will be a list of providers that support payments.
Each payment provider can support multiple ways of initiating a payment. Each of this method is called a payment_template.
For instance, we can see from the response that provider fake_client_xf supports payment templates SEPA, FPS and SWIFT.
URL
https://www.saltedge.com/api/payments/v1/providers
https://www.saltedge.com/api/payments/v1/providers
Method
GET
Sample Request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/providerscurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/providersSample Response
{
"data": [
{
"id": "3100",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "api",
"status": "active",
"interactive": true,
"instruction": "Valid credentials for this provider are:\nlogin - any string which starts with \"username\",\npassword - \"secret\"\n",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://test.cloudfront.net/logos/providers/xf/fake_client_xf.svg",
"country_code": "XF",
"created_at": "2018-07-02T11:53:11Z",
"updated_at": "2018-07-02T11:53:11Z",
"identification_mode": "client"
"payment_templates": [
"SEPA",
"FPS",
"SWIFT"
]
},
...
],
"meta": {
"next_id": null,
"next_page": null
}
}
Choose payment template
Since in previous steps we only added client keys for provider fake_client_xf, we can only execute payments using payment templates supported by this provider - SEPA, FPS, and SWIFT.
For the purposes of this guide, let’s stick with SEPA. We need to save the payment template identifier (in this case SEPA), because we will use it later.
$ export PAYMENT_TEMPLATE=SEPA
To get the payment templates fields, we need to execute the following request.
The response will be a payment template object with payment fields.
From the response, we can see that payment template SEPA requires the following fields (none of them have optional flag set to true, thus all are mandatory):
end_to_end_idcustomer_last_logged_atcustomer_ip_addresscreditor_namecreditor_country_codecurrency_codeamountdescriptioncreditor_iban
The data type for each of these fields is represented by the nature field.
URL
https://www.saltedge.com/api/payments/v1/templates/{payment_template}
https://www.saltedge.com/api/payments/v1/templates/{payment_template}
Method
GET
Sample Request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/templates/$PAYMENT_TEMPLATEcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/templates/$PAYMENT_TEMPLATESample Response
{
"data": {
"id": "29",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-10-30T12:03:00Z",
"payment_fields": [
{
"id": "234",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "235",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "236",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "238",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "219",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "222",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "207",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "213",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "221",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "224",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "216",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "212",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "218",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "223",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "225",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "226",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "227",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "228",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "229",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "230",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "231",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "232",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "208",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "209",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "211",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "233",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-21T16:27:16Z"
},
{
"id": "205",
"payment_template_id": "29",
"name": "end_to_end_id",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-21T16:59:14Z"
},
{
"id": "239",
"payment_template_id": "29",
"name": "reference",
"english_name": "Payment Reference",
"localized_name": "Payment Reference",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-21T16:59:14Z"
},
{
"id": "214",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "215",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "217",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "220",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "237",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "210",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
},
{
"id": "206",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2018-11-27T17:07:23Z",
"updated_at": "2019-01-15T14:49:17Z"
}
]
}
}
Initiate payment
To initiate a payment in Salt Edge Connect, we need to execute a request to create a payment.
The response will contain the connect_url. This is the URL we will visit to authorize the user and initiate the payment.
URL
https://www.saltedge.com/api/payments/v1/payments/connect
https://www.saltedge.com/api/payments/v1/payments/connect
Method
POST
Sample Request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_client_xf\", \
\"show_consent_confirmation\": true, \
\"template_identifier\": \"SEPA\", \
\"return_to\": \"http://example.com/\", \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"customer_last_logged_at\": \"2020-06-06T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_post_code\": \"E14 5AB\", \
\"creditor_town\": \"London\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"EUR\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"mode\": \"normal\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/connectcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_client_xf\", \
\"show_consent_confirmation\": true, \
\"template_identifier\": \"SEPA\", \
\"return_to\": \"http://example.com/\", \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"customer_last_logged_at\": \"2020-06-06T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_post_code\": \"E14 5AB\", \
\"creditor_town\": \"London\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"EUR\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"mode\": \"normal\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/connectSample Response
{
"data": {
"token": "GENERATED_TOKEN",
"expires_at": "2020-07-03T07:23:58Z",
"connect_url": "https://www.saltedge.com/payments/connect?token=GENERATED_TOKEN"
}
}
Visit connect url
Visit the connect_url from the previous API response. You will be presented with a form for user credentials input. Put “fake” in search and choose a Fake Bank:
Input username and secret as per the on-screen instructions and press Proceed.
After that, you will see the consent window.
After confirming, it will start to initiate the payment.
In case the provider has interactive fields, a form will be presented for filling these fields.
After that, we will have to wait for the payment process to finish.
Try in Postman
Step 1
Install Postman. You can get it on https://www.getpostman.com/apps.
Step 2
Import the postman collection, click the below button to do that.
Step 3
Payment Initiation API requires APP_ID and SECRET headers in order to authenticate its clients. If you don’t have an API key created yet, you can you use our quick start guide to help you create one. Once you have the API key created, you can add its secrets to postman.
Click on the eye on the top right corner and press on “Add” next to “Environments”.
Define variables APP_ID and SECRET with values from the key that you generated on Keys and Secrets page, then add the environment.
Once added, you can select it in the top right corner, and all the requests to Payment Initiation API will be authenticated using your API key.
Salt Edge Connect
The most simple and easy way to execute payments in Payment Initiation API is to use Salt Edge Connect.
Salt Edge Connect is a web page that handles all the user interaction during a payment initiation process:
- user credentials input
- interactive confirmation
- progress reporting
- error reporting
After your application has received an URL for executing a payment using Salt Edge Connect, you can redirect your end-user to it. There, they will see a screen that lets them pick a provider to execute a payment.
Your user will also be asked to input their credentials and, if needed, any of the interactive credentials.
After the process is done, the user will be redirected back to your application URL, or to the URL
specified as return_to argument to create payment endpoint.
You can easily test Connect from your Dashboard
page by pressing New Payment button or by using the create payment route.
Embed connect in your app
At the moment, the only way to embed Salt Edge Connect in your application is to open it in a pop-up.
When opening it in a pop-up using window.open, it will post notifications during the payment process.
To enable these notifications when you request an URL for executing payments, you can pass an optional argument javascript_callback_type with the value post_message.
This tells Salt Edge Connect to use postMessage for sending messages to a parent window.
You can then subscribe to those messages by calling window.addEventListener("message", callback) in the parent window.
Sample Request
window.addEventListener("message", function(event) {
console.log(JSON.parse(event.data))
}
)
Sample Response
{
data: {
payment_id: "131313131313131313",
custom_fields: {},
stage: "start",
status: "processing"
}
}
Callbacks
The most important parts of Payment Initiation API (e.g. Payment initiation) are asynchronous.
Every Web application has to provide a set of valid URLs which we will use to notify about the payment progress. Other applications can poll Payment Initiation API in order to retrieve the current payment status.
There are several common points about the request we send to the callback URLs provided by the client:
- The
Content-Typeheader isapplication/json; - There is a
Signatureheader that identifies the request was signed by Payment Initiation API; - The request method is always
POST; - The JSON object sent will always have a
datafield; - The
metafield will display the version of the callbacks API.
You can set the callback URLs for your application by accessing your Payment Initiation tab on the callbacks page.
Due to security reasons, the callbacks can be sent to ports 80/HTTP (in test and pending modes) and 443/HTTPS (in test, pending and live modes) only!
Also, the callbacks do not follow redirects.
Signature
In order for the client to identify that the request is coming from Payment Initiation API, there is a Signature header in the request.
Signature - base64 encoded SHA256 signature of the string represented in the
form callback_url|post_body - 2 parameters concatenated
with a vertical bar |, signed with a Payment Initiation API’s private key. You can find the version of the signature key used to sign the callback in the Signature-key-version header. The current version is 4.0 which corresponds to the following public key:
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzi1XL1b0XwUYVHj7/AR6
Hr0YN34wH/bDOIub0nwt0s/s3tD+DPxNB85xpMEZrLikPW5PAKkQ/oC3OyPYxKOb
8TNhzGmQhEfyCkbdRwxNZqRMRwuOc+N4sdBtQKPN8+XF3RIcRZAk25JGROtb1M2o
d/Nb9QqdQwMjdk6W+Vdq5Sj25Tj2efJc8zmBJkNXR4WtW45p4XSdjSEjuVCSZjOy
+N8/Od8MGixC99jYbiKm3RrVDJCgDi4YYnNRI0QgxZRpJKbQX/WeZiYOrbctG3m8
l1/Hpkv3w1QHz/YFIshCOKwUL+xg1hLMaW4IH7XFHenE+JlUKdCqhcWyi7oIDkyr
7wIDAQAB
-----END PUBLIC KEY-----
An example of the string that is to be used to generate the signature looks as follows:
https://www.client.com/api/payments/callbacks/success|{"data":{"payment_id":"131313131313131313","customer_id":"222222222222222222","custom_fields":{},"status": "processing"},"meta":{"version":"1","time":"2017-01-03T13:00:28Z"}}
The pseudocode that we use to generate the signature looks like this:
base64(sha256_signature(private_key, "callback_url|post_body"))
Success
We send a callback to your application’s success URL whenever an operation has caused a change in the data we store for a particular payment.
For instance, after you’ve redirected your user to the Connect page and they have selected their provider, gave their consent and pressed Proceed, we’ll send you a success callback.
This callback will contain the customer identifier, the id of the newly created payment and its status.
Afterwards, your application will be able to use the show payment route and query the information about this payment.
Whenever we have more information about the payment, we will send another success callback.
A success callback marks a change in the data and you can generally expect from one to three success callbacks with the same payload within several minutes.
We recommend that your application fetch the full payment data at each callback, as some information might change during the fetching process.
For instance, when your user has initiated a payment using Salt Edge Connect, we will send the following success callback:
{
"data": {
"payment_id": "131313131313131313",
"customer_id": "222222222222222222",
"custom_fields": { "key": "value" },
"status": "processing"
},
"meta": {
"version": "1",
"time": "2020-09-25T10:57:27.330Z"
}
}
You can now use the show payment route and obtain the provider and some other attributes of the new payment.
Failure
Sometimes a payment will fail to go through.
It might happen because the interactive data was not sent by the end-user, provider access was not granted or we could not perform one of the steps of the payment process.
In this case, you will receive a fail callback, containing a JSON similar to the following:
{
"data": {
"payment_id": "131313131313131313",
"customer_id": "222222222222222222",
"custom_fields": { "key": "value" },
"status": "rejected",
"error_class": "ProviderAccessNotGranted",
"error_message": "Provider access was not granted"
},
"meta": {
"version": "1",
"time": "2020-09-25T10:57:27.344Z"
}
}
After you get this callback, you need to request the payment to check for its updates. Please note that even if there’s an error, we still store the payment.
Notify
After a new payment was created in the payment initialization process, Salt Edge can inform you about the progress the payment is going through using a notify callback.
Your app can expect the notify callback several times, but you can use this information to inform your end-user about what’s happening with their payment.
The possible stages sent in a notify callback are described here.
Here’s an example callback sent to the /notify route of your app:
{
"data": {
"payment_id": "131313131313131313",
"customer_id": "222222222222222222",
"custom_fields": { "key": "value" },
"stage": "submission",
"stage_id": "242424242424242424",
"status": "processing"
},
"meta": {
"version": "1",
"time": "2020-09-24T10:57:27Z"
}
}
For some of the payments you might not receive all the stages.
Interactive
Some of the providers require an additional step in the payment initialization process, asking users to input an SMS, Token, solve a CAPTCHA, etc.
Whenever we encounter that the payment initialization process requires an interactive step, we will send the interactive callback to the interactive route set in your app’s profile. Your app should prompt the user for the interactive credentials and send them to the confirm route.
We also send a snippet of HTML so that it would be easier for your app to display the CAPTCHA or image to the user.
If the provider requires filling a CAPTCHA, the img tag in the HTML will contain the image URL.
During this process, the payment’s stage will be set to interactive.
The interactive callback should contain the values of the interactive_credentials field
from the corresponding provider.
Here’s an example callback sent to your app’s /confirm route:
{
"data": {
"payment_id": "131313131313131313",
"customer_id": "222222222222222222",
"status": "processing",
"html": "<div id='interactive'><img src='https://docs.saltedge.com/images/saltedge_captcha.png' width='10' height='10' alt='some description' title='some description'></div>",
"stage": "interactive",
"stage_id": "242424242424242424",
"session_expires_at": "2020-09-24T11:57:27Z",
"interactive_fields_names": ["image"],
"custom_fields": { "key": "value" }
},
"meta": {
"version": "4",
"time": "2020-09-24T10:57:27Z"
}
}
Interactive Redirect
Some OAuth providers require 2 redirects for payment authorization. In these cases, for the 2nd redirect Salt Edge will send an interactive callback with redirect_url field:
{
"data": {
"payment_id": "131313131313131313",
"customer_id": "222222222222222222",
"status": "processing",
"html": "",
"redirect_url": "https://bank.com/authorize"
"stage": "interactive",
"stage_id": "242424242424242424",
"session_expires_at": "2020-09-24T11:57:27Z",
"interactive_fields_names": [],
"custom_fields": { "key": "value" }
},
"meta": {
"version": "4",
"time": "2020-09-24T10:57:27Z"
}
}
In these cases, your application should redirect the user to redirect_url field
value of the interactive callback payload. Once the end-user will be authorized on the provider’s side, they will be redirected to the return_to url indicated in the initiate payment request, with a bunch of parameters appended to it by the provider that are needed for authorizing the payment. Those parameters need to be sent to the payments confirm route as query_string field.
Errors
The Payment Initiation API can return multiple errors for any operation, each having its meaning and usage.
Attributes
error_class
string
The class of the error, one of the listed below
error_message
string
A message describing the error
request
object
The body of the request that caused the error
error_class
string
The class of the error, one of the listed below
error_message
string
A message describing the error
request
object
The body of the request that caused the error
Error codes
[400] Bad Request
[404] Not Found
[406] Not Acceptable
[409] Duplicated
Sample response
{
"error_class": "PaymentNotFound",
"error_message": "Payment with id: '131313131313131313' was not found.",
"request": {
"id": "131313131313131313"
}
}
List
ApiKeyNotFound
400 Bad Request
The API key with the provided App-id and Secret does not exist or is inactive
AppIdNotProvided
400 Bad Request
The App-id was not provided in request headers
ClientNotFound
404 Not Found
The API key used in the request does not belong to an existing client
ConnectionFailed
406 Not Acceptable
Some network errors appear while fetching data
ConnectionLost
Internet connection was lost in the process
CountryNotFound
404 Not Found
Sending a country_code that is not present in our system
CustomFieldsFormatInvalid
406 Not Acceptable
The custom_fields field is not of type object
CustomFieldsSizeTooBig
406 Not Acceptable
The custom_fields object has more than 1 KB
CustomerNotFound
404 Not Found
A customer with such customer_id does not exist
DateOutOfRange
400 Bad Request
Sending a date value that does not fit in admissible range
DuplicatedCustomer
409 Duplicated
The customer you are trying to create already exists
EmailInvalid
406 Not Acceptable
The passed email does not exist
ExpiresAtInvalid
400 Bad Request
The Expires-at header is invalid, or is set to more than 1 hour from now in UTC
IdentifierInvalid
406 Not Acceptable
Invalid identifier sent for creating a new customer
InteractiveTimeout
400 Bad Request
It took too long to respond to the interactive question
InternalServerError
500 Internal Server Error
An internal error has occured
InvalidCredentials
406 Not Acceptable
The customer tried to initiate a payment with invalid credentials
InvalidEncoding
400 Bad Request
Invalid JSON encoded values
InvalidInteractiveCredentials
406 Not Acceptable
Interactive credentials that were sent are wrong
InvalidPaymentAttributes
406 Not Acceptable
Invalid payment attributes
JsonParseError
400 Bad Request
We have received some other request format instead of JSON, or the body could not be parsed
MissingExpiresAt
400 Bad Request
The Expires-at field is missing in the headers
MissingSignature
400 Bad Request
The Signature field is missing in the headers
PaymentAlreadyFinished
406 Not Acceptable
The payment is already executed
PaymentAlreadyStarted
406 Not Acceptable
The payment is in progress
PaymentInitiationTimeout
406 Not Acceptable
The payment execution expired
PaymentLimitReached
406 Not Acceptable
The client exceeded the number of payments allowed in Test or Pending status
PaymentNotFinished
406 Not Acceptable
The payment has not finished yet
PaymentNotFound
404 Not Found
A payment with such attributes cannot be found
PaymentTemplateNotFound
404 Not Found
The payment template does not exist
PaymentTemplateNotSupported
406 Not Acceptable
The chosen provider does not support the desired payment template
ProviderAccessNotGranted
406 Not Acceptable
The customer denied access to his/her data from the provider’s page
ProviderDisabled
406 Not Acceptable
The accessed provider is disabled
ProviderError
406 Not Acceptable
There’s an error on the provider’s side which obstructs us from initiating the payment
ProviderInactive
406 Not Acceptable
The accessed provider is inactive at the moment
ProviderNotFound
404 Not Found
Sending a provider_code that is not present in our system
ProviderNotInteractive
406 Not Acceptable
The payment’s provider has no interactive step
RateLimitExceeded
406 Not Acceptable
Too many payments are being processed at the same time from one application
RequestExpired
400 Bad Request
The request has expired, took longer than mentioned in the expires-at header
ReturnURLTooLong
406 Not Acceptable
The return_to URL exceeds 2040 characters
RouteNotFound
404 Not Found
The action you are trying to access does not exist
SecretNotProvided
400 Bad Request
The Secret was not provided in request headers
SignatureNotMatch
400 Bad Request
The Signature header does not match with the correct one
TooManyRequests
400 Bad Request
Excessive number of requests have occured for initiating payments from one IP address in a small period of time
ValueOutOfRange
400 Bad Request
Sending a value (e.g. id) which exceeds integer limit
WrongRequestFormat
400 Bad Request
The JSON request is incorrectly formed
ApiKeyNotFound
400 Bad Request
The API key with the provided App-id and Secret does not exist or is inactive
AppIdNotProvided
400 Bad Request
The App-id was not provided in request headers
ClientNotFound
404 Not Found
The API key used in the request does not belong to an existing client
ConnectionFailed
406 Not Acceptable
Some network errors appear while fetching data
ConnectionLost
Internet connection was lost in the process
CountryNotFound
404 Not Found
Sending a country_code that is not present in our system
CustomFieldsFormatInvalid
406 Not Acceptable
The custom_fields field is not of type object
CustomFieldsSizeTooBig
406 Not Acceptable
The custom_fields object has more than 1 KB
CustomerNotFound
404 Not Found
A customer with such customer_id does not exist
DateOutOfRange
400 Bad Request
Sending a date value that does not fit in admissible range
DuplicatedCustomer
409 Duplicated
The customer you are trying to create already exists
EmailInvalid
406 Not Acceptable
The passed email does not exist
ExpiresAtInvalid
400 Bad Request
The Expires-at header is invalid, or is set to more than 1 hour from now in UTC
IdentifierInvalid
406 Not Acceptable
Invalid identifier sent for creating a new customer
InteractiveTimeout
400 Bad Request
It took too long to respond to the interactive question
InternalServerError
500 Internal Server Error
An internal error has occured
InvalidCredentials
406 Not Acceptable
The customer tried to initiate a payment with invalid credentials
InvalidEncoding
400 Bad Request
Invalid JSON encoded values
InvalidInteractiveCredentials
406 Not Acceptable
Interactive credentials that were sent are wrong
InvalidPaymentAttributes
406 Not Acceptable
Invalid payment attributes
JsonParseError
400 Bad Request
We have received some other request format instead of JSON, or the body could not be parsed
MissingExpiresAt
400 Bad Request
The Expires-at field is missing in the headers
MissingSignature
400 Bad Request
The Signature field is missing in the headers
PaymentAlreadyFinished
406 Not Acceptable
The payment is already executed
PaymentAlreadyStarted
406 Not Acceptable
The payment is in progress
PaymentInitiationTimeout
406 Not Acceptable
The payment execution expired
PaymentLimitReached
406 Not Acceptable
The client exceeded the number of payments allowed in Test or Pending status
PaymentNotFinished
406 Not Acceptable
The payment has not finished yet
PaymentNotFound
404 Not Found
A payment with such attributes cannot be found
PaymentTemplateNotFound
404 Not Found
The payment template does not exist
PaymentTemplateNotSupported
406 Not Acceptable
The chosen provider does not support the desired payment template
ProviderAccessNotGranted
406 Not Acceptable
The customer denied access to his/her data from the provider’s page
ProviderDisabled
406 Not Acceptable
The accessed provider is disabled
ProviderError
406 Not Acceptable
There’s an error on the provider’s side which obstructs us from initiating the payment
ProviderInactive
406 Not Acceptable
The accessed provider is inactive at the moment
ProviderNotFound
404 Not Found
Sending a provider_code that is not present in our system
ProviderNotInteractive
406 Not Acceptable
The payment’s provider has no interactive step
RateLimitExceeded
406 Not Acceptable
Too many payments are being processed at the same time from one application
RequestExpired
400 Bad Request
The request has expired, took longer than mentioned in the expires-at header
ReturnURLTooLong
406 Not Acceptable
The return_to URL exceeds 2040 characters
RouteNotFound
404 Not Found
The action you are trying to access does not exist
SecretNotProvided
400 Bad Request
The Secret was not provided in request headers
SignatureNotMatch
400 Bad Request
The Signature header does not match with the correct one
TooManyRequests
400 Bad Request
Excessive number of requests have occured for initiating payments from one IP address in a small period of time
ValueOutOfRange
400 Bad Request
Sending a value (e.g. id) which exceeds integer limit
WrongRequestFormat
400 Bad Request
The JSON request is incorrectly formed
api
Pay with Connect
The easiest way to initiate payments using Payment Initiation API is to use Salt Edge Connect, which handles all the authentication interaction with the user.
After you execute the request, you will receive a connect_url field, which you need to redirect the user to in order to process with the payment flow.
Please see the sequence diagram for details on how to handle payments via Connect.
Parameters
provider_code
string, optional
The code of the desired provider. To access the list of providers that support payments, see providers list. If passed, make sure the chosen provider supports the desired payment template
payment_attributes
object
All the attributes (required and optional) that are needed for a successful payment initiation received in show templates
return_to
string, optional
The URL the user will be redirected to. Defaults to the client's home URL
show_consent_confirmation
boolean, optional
If sent as false, upon submitting the form, the end-user will not be asked to give their consent to Salt Edge Inc. Defaults to true.
disable_provider_search
boolean, optional
If sent as true, together with provider_code, does not allow the end-user to change the preselected provider. Defaults to false.
javascript_callback_type
string, optional
Allows you to specify what kind of callback type you are expecting. Possible values: post_message. Defaults to null.
return_payment_id
boolean, optional
Whether to append payment_id to return_to URL. Defaults to false.
return_error_class
boolean, optional
Whether to append error_class to return_to URL. Defaults to false.
provider_code
string, optional
The code of the desired provider. To access the list of providers that support payments, see providers list. If passed, make sure the chosen provider supports the desired payment template
payment_attributes
object
All the attributes (required and optional) that are needed for a successful payment initiation received in show templates
return_to
string, optional
The URL the user will be redirected to. Defaults to the client's home URL
show_consent_confirmation
boolean, optional
If sent as false, upon submitting the form, the end-user will not be asked to give their consent to Salt Edge Inc. Defaults to true.
disable_provider_search
boolean, optional
If sent as true, together with provider_code, does not allow the end-user to change the preselected provider. Defaults to false.
javascript_callback_type
string, optional
Allows you to specify what kind of callback type you are expecting. Possible values: post_message. Defaults to null.
return_payment_id
boolean, optional
Whether to append payment_id to return_to URL. Defaults to false.
return_error_class
boolean, optional
Whether to append error_class to return_to URL. Defaults to false.
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| ActionNotSupported | 406 Not Acceptable | At least one of current eIDAS certificates does not have the |
| CertificateNotFound | 400 Bad Request | Current client does not have QWAC and QSEAL certificates |
| CustomerLocked | 406 Not Acceptable | If current customer is locked. It may be unlocked |
| InvalidPaymentAttributes | 406 Not Acceptable | Some of the |
| PaymentTemplateNotSupported | 406 Not Acceptable | The |
| WrongRequestFormat | 400 Bad Request | The |
URL
https://www.saltedge.com/api/payments/v1/payments/connect
https://www.saltedge.com/api/payments/v1/payments/connect
Method
POST
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_client_xf\", \
\"show_consent_confirmation\": true, \
\"template_identifier\": \"SEPA\", \
\"return_to\": \"http://example.com/\", \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"reference\": \"p:131313131313131313\", \
\"customer_last_logged_at\": \"2020-07-12T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_post_code\": \"E14 5AB\", \
\"creditor_town\": \"London\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"EUR\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"mode\": \"normal\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/connectcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_client_xf\", \
\"show_consent_confirmation\": true, \
\"template_identifier\": \"SEPA\", \
\"return_to\": \"http://example.com/\", \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"reference\": \"p:131313131313131313\", \
\"customer_last_logged_at\": \"2020-07-12T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_post_code\": \"E14 5AB\", \
\"creditor_town\": \"London\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"EUR\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"mode\": \"normal\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/connectSample response
{
"data": {
"expires_at": "2020-09-25T11:57:27Z",
"connect_url": "https://www.saltedge.com/payments/connect?token=GENERATED_TOKEN"
}
}{
"data": {
"expires_at": "2020-09-25T11:57:27Z",
"connect_url": "https://www.saltedge.com/payments/connect?token=GENERATED_TOKEN"
}
}Pay with Direct API
If you wish to handle the credentials, consent and authorization for payments yourself, you can create payments directly via the API.
Create
Your app will have to pass the user’s values of provider’s fields within the payload in the credentials object.
Please note that you still have to use redirects (see OAuth in all cases when the provider mode is oauth).
The credentials object should be modeled after the provider’s fields.
For instance, if the provider’s required fields contain a field with the value of name equal to username, the credential object should contain a username attribute with the value being the actual username.
For example, here’s a provider:
{
"data": {
"code": "bigbank_us",
"required_fields": [
{
"english_name": "Pass Code",
"localized_name": "Pass Code",
"name": "code",
"nature": "text",
"position": 1
}
]
}
}
The user should be prompted to input their Pass Code.
If they input their Pass Code (in this case, the user has input “hunter2”), your app should send the following data in the credentials object:
{
"code": "hunter2"
}
Here’s another example that includes a select:
{
"data": {
"code": "anotherbank_us",
"required_fields": [
{
"english_name": "Password",
"localized_name": "Password",
"name": "password",
"nature": "password",
"position": 1
},
{
"nature": "select",
"name": "image",
"english_name": "Image",
"localized_name": "Imagine",
"position": 2,
"optional": false,
"field_options": [
{
"name": "1",
"english_name": "Home",
"localized_name": "Casa",
"option_value": "home",
"selected": false
},
{
"name": "2",
"english_name": "Car",
"localized_name": "Automobil",
"option_value": "car",
"selected": false
}
]
}
]
}
}
In this case, your app should prompt the user to input their Password and offer them a select with the options of “Casa” and “Automobil” (the localized_name or english_name values, depending on your service).
The credentials should contain the name of the select field (in this case image) as the key and the user’s selected option_value as its value.
Let’s say the user has input hunter2 as their password and has chosen “Automobil” from the select.
The credentials object should look like this:
{
"password": "hunter2",
"image": "car"
}
Please see the sequence diagram for details on how to handle embedded payments correctly.
Payments workflow does not currently support encrypted credentials.
Parameters
provider_code
string
The code of the desired provider. To access the list of providers that support payments, see providers list
credentials
object
The credentials required to initiate a payment
payment_attributes
object
All the attributes (required and optional) that are needed for a successful payment initiation received in show templates
custom_fields
object, optional
A JSON object, which will be sent back on any of your callbacks
provider_code
string
The code of the desired provider. To access the list of providers that support payments, see providers list
credentials
object
The credentials required to initiate a payment
payment_attributes
object
All the attributes (required and optional) that are needed for a successful payment initiation received in show templates
custom_fields
object, optional
A JSON object, which will be sent back on any of your callbacks
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| CustomerLocked | 406 Not Acceptable | If the current customer is locked. It can be unlocked |
| InvalidCredentials | 406 Not Acceptable | Some critical information is missing from the request (e.g. a specific field in certificate) |
| InvalidPaymentAttributes | 406 Not Acceptable | Some of the |
| PaymentTemplateNotSupported | 406 Not Acceptable | The |
| ProviderInactive | 406 Not Acceptable | The selected provider is not |
| ProviderUnavailable | 406 Not Acceptable | Unable to contact provider in order to generate |
| WrongProviderMode | 406 Not Acceptable | If current provider’s mode is neither |
| WrongRequestFormat | 400 Bad Request | Either |
URL
https://www.saltedge.com/api/payments/v1/payments
https://www.saltedge.com/api/payments/v1/payments
Method
POST
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_client_xf\", \
\"credentials\": { \
\"login\": \"username\", \
\"password\": \"secret\" \
}, \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"reference\": \"p:474747474747474747\", \
\"customer_last_logged_at\": \"2020-07-23T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"GBP\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"mode\": \"normal\" \
}, \
\"template_identifier\": \"SEPA\" \
} \
}" \
https://www.saltedge.com/api/payments/v1/paymentscurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_client_xf\", \
\"credentials\": { \
\"login\": \"username\", \
\"password\": \"secret\" \
}, \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"reference\": \"p:474747474747474747\", \
\"customer_last_logged_at\": \"2020-07-23T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"GBP\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"mode\": \"normal\" \
}, \
\"template_identifier\": \"SEPA\" \
} \
}" \
https://www.saltedge.com/api/payments/v1/paymentsSample response
{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-07-24T08:02:57Z",
"updated_at": "2020-07-24T08:02:57Z",
"status": "processing",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-07-23T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"stages": [
{
"name": "initiated",
"created_at": "2020-07-24T08:02:57Z"
}
]
}
}{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-07-24T08:02:57Z",
"updated_at": "2020-07-24T08:02:57Z",
"status": "processing",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-07-23T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"stages": [
{
"name": "initiated",
"created_at": "2020-07-24T08:02:57Z"
}
]
}
}OAuth
Since initiating payments with OAuth providers implies a redirect, the flow for these providers is similar to Pay with Connect. The response will contain a redirect_url and your app has to redirect the user to that URL.
The redirect_url points to a page where the user can provide PISP access to make payments, making it available for your app.
After the user has approved PISP in the OAuth provider’s interface, they will be redirected to the return_to page. Note that return_to is optional for clients only if they use a shared (owned by Salt Edge) provider key(it is set as the client’s home_url by default). If clients use their own provider keys, return_to is mandatory and should be a valid URL that was registered within the chosen provider.
Please see the sequence diagram for details on how to handle OAuth payments directly.
Parameters
provider_code
string
The code of the desired oauth provider. To access the list of providers that support payments, see providers list.
payment_attributes
object
All the attributes (required and optional) that are needed for a successful payment initiation received in show templates
return_to
string
The URL the user will be redirected to after they authenticate on the provider’s side. If you used your own provider keys for the chosen provider, the URL to which the end-user will be redirected will contain a bunch of parameters appended by the provider that you need to send to the authorize route in order to authorize the payment
provider_code
string
The code of the desired oauth provider. To access the list of providers that support payments, see providers list.
payment_attributes
object
All the attributes (required and optional) that are needed for a successful payment initiation received in show templates
return_to
string
The URL the user will be redirected to after they authenticate on the provider’s side. If you used your own provider keys for the chosen provider, the URL to which the end-user will be redirected will contain a bunch of parameters appended by the provider that you need to send to the authorize route in order to authorize the payment
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| ActionNotSupported | 406 Not Acceptable | The current eIDAS certificate does not have the |
| CertificateNotFound | 400 Bad Request | The current client does not have QWAC and QSEAL certificates |
| CustomerLocked | 406 Not Acceptable | If the current customer is locked. It can be unlocked |
| InvalidPaymentAttributes | 406 Not Acceptable | Some of the |
| ProviderDisabled | 406 Not Acceptable | The current provider was |
| ProviderInactive | 406 Not Acceptable | The selected provider is not |
| ProviderUnavailable | 406 Not Acceptable | Unable to contact the provider in order to generate |
| ReturnURLInvalid | 406 Not Acceptable | If |
| WrongProviderMode | 406 Not Acceptable | If current provider’s mode is not |
| WrongRequestFormat | 400 Bad Request | Either |
URL
https://www.saltedge.com/api/payments/v1/payments/oauth
https://www.saltedge.com/api/payments/v1/payments/oauth
Method
POST
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_oauth_client_xf\", \
\"template_identifier\": \"SEPA\", \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"reference\": \"p:474747474747474747\", \
\"customer_last_logged_at\": \"2020-07-23T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"GBP\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"creditor_post_code\": \"E14 5AB\", \
\"mode\": \"normal\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/oauthcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"customer_id\": \"222222222222222222\", \
\"provider_code\": \"fake_oauth_client_xf\", \
\"template_identifier\": \"SEPA\", \
\"payment_attributes\": { \
\"end_to_end_id\": \"#123123123\", \
\"reference\": \"p:474747474747474747\", \
\"customer_last_logged_at\": \"2020-07-23T13:48:40Z\", \
\"customer_ip_address\": \"10.0.0.1\", \
\"customer_device_os\": \"iOS 11\", \
\"creditor_name\": \"Jay Dawson\", \
\"creditor_street_name\": \"One Canada Square\", \
\"creditor_building_number\": \"One\", \
\"creditor_country_code\": \"UK\", \
\"currency_code\": \"GBP\", \
\"amount\": \"199000.00\", \
\"description\": \"Stocks purchase\", \
\"creditor_iban\": \"GB33BUKB20201555555555\", \
\"creditor_post_code\": \"E14 5AB\", \
\"mode\": \"normal\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/oauthSample response
{
"data": {
"payment_id": "131313131313131313",
"expires_at": "2020-09-25T11:57:27Z",
"redirect_url": "https://www.saltedge.com/api/payments/v1/payments/redirect?token=GENERATED_TOKEN"
}
}{
"data": {
"payment_id": "131313131313131313",
"expires_at": "2020-09-25T11:57:27Z",
"redirect_url": "https://www.saltedge.com/api/payments/v1/payments/redirect?token=GENERATED_TOKEN"
}
}Confirm
If the currently processing payment requires any interactive credentials, your app should ask the user for the interactive credentials and send them to the /confirm route. After that, the process will continue as usual.
In case of dynamic_select field nature, send the option_value of the user selected options in an array:
{
"data": {
"interactive_fields": {
"accounts": ["account1", "account2"]
}
}
}
Please note that in some cases, on the interactive stage the provider may not require any interactive fields (see interactive_fields_names), thus you should send an empty object in the interactive_fields field:
{
"data": {
"interactive_fields": {}
}
}
In case of an interactive redirect, once the end-user is redirected to your return_to URL, the query string appendend to your return_to should be sent to /confirm route:
Examples:
<return_to url>?code=bc4521d3&state=Pd8b4d0eb
<return_to url>#code=bc4521d3&state=Pd8b4d0eb
For both cases, the query_string that is needed to authorize the payment is code=bc4521d3&state=Pd8b4d0eb.
Parameters
payment_id
string
The id of the payment
data
object
payment_id
string
The id of the payment
data
object
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| PaymentAlreadyFinished | 406 Not Acceptable | The payment is finished i.e. |
| PaymentNotFound | 404 Not Found | The |
| WrongRequestFormat | 400 Bad Request | Interactive fields key is missing from the request body |
URL
https://www.saltedge.com/api/payments/v1/payments/{payment.id}/confirm
https://www.saltedge.com/api/payments/v1/payments/{payment.id}/confirm
Method
PUT
Sample request (interactive confirmation)
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
-d "{ \
\"data\": { \
\"interactive_fields\": { \
\"confirmation_code\": \"123456\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/10/confirmcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
-d "{ \
\"data\": { \
\"interactive_fields\": { \
\"confirmation_code\": \"123456\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/10/confirmSample request (interactive redirect)
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
-d "{ \
\"data\": { \
\"interactive_fields\": { \
\"query_string\": \"code=bc4521d3&state=Pd8b4d0eb\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/10/confirmcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
-d "{ \
\"data\": { \
\"interactive_fields\": { \
\"query_string\": \"code=bc4521d3&state=Pd8b4d0eb\" \
} \
} \
}" \
https://www.saltedge.com/api/payments/v1/payments/10/confirmSample response
{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-07-27T08:02:57Z",
"updated_at": "2020-07-27T08:02:57Z",
"status": "processing",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-07-26T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"custom_fields": {
},
"stages": [
{
"name": "initialize",
"created_at": "2020-07-27T10:38:11Z"
},
{
"name": "start",
"created_at": "2020-07-27T10:38:14Z"
},
{
"name": "submission",
"created_at": "2020-07-27T10:38:14Z"
},
{
"name": "interactive",
"created_at": "2020-07-27T12:11:17Z",
"interactive_html": " <div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'><span>Please authorize payment for total of 100.35 EUR.</span><ol> <li value=''>Payment fee.: 0.1 EUR</li><li value=''>Bank fee.: 0.25 EUR</li></ol></div>",
"interactive_fields_names": [
"confirmation_code"
],
"interactive_fields_options": null
},
{
"name": "submission",
"created_at": "2020-07-27T10:38:23Z",
"interactive_fields": {
"iban": "XF123456789012345678"
}
}
]
}
}{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-07-27T08:02:57Z",
"updated_at": "2020-07-27T08:02:57Z",
"status": "processing",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-07-26T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"custom_fields": {
},
"stages": [
{
"name": "initialize",
"created_at": "2020-07-27T10:38:11Z"
},
{
"name": "start",
"created_at": "2020-07-27T10:38:14Z"
},
{
"name": "submission",
"created_at": "2020-07-27T10:38:14Z"
},
{
"name": "interactive",
"created_at": "2020-07-27T12:11:17Z",
"interactive_html": " <div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'><span>Please authorize payment for total of 100.35 EUR.</span><ol> <li value=''>Payment fee.: 0.1 EUR</li><li value=''>Bank fee.: 0.25 EUR</li></ol></div>",
"interactive_fields_names": [
"confirmation_code"
],
"interactive_fields_options": null
},
{
"name": "submission",
"created_at": "2020-07-27T10:38:23Z",
"interactive_fields": {
"iban": "XF123456789012345678"
}
}
]
}
}Cancel
Allows you to cancel the payment initiation.
Note: a payment can be canceled only being in the initialize stage.
payment_id
string
The id of the payment
payment_id
string
The id of the payment
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| PaymentNotFound | 404 Not Found | The |
URL
https://www.saltedge.com/api/payments/v1/payments/{payment.id}/cancel
https://www.saltedge.com/api/payments/v1/payments/{payment.id}/cancel
Method
PUT
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
https://www.saltedge.com/api/payments/v1/payments/10/cancelcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
https://www.saltedge.com/api/payments/v1/payments/10/cancelSample response
{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-07-27T12:19:25Z",
"updated_at": "2020-07-2712:19:33Z",
"status": "rejected",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-07-25T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"custom_fields": {
},
"stages": [
{
"name": "initialize",
"created_at": "2020-07-27T12:19:25Z"
},
{
"name": "start",
"created_at": "2020-07-27T12:19:25Z"
},
{
"name": "submission",
"created_at": "2020-07-27T12:19:25Z"
},
{
"name": "interactive",
"created_at": "2020-07-27T12:11:17Z",
"interactive_html": " <div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'><span>Please authorize payment for total of 100.35 EUR.</span><ol> <li value=''>Payment fee.: 0.1 EUR</li><li value=''>Bank fee.: 0.25 EUR</li></ol></div>",
"interactive_fields_names": [
"confirmation_code"
],
"interactive_fields_options": null
},
{
"name": "finish",
"created_at": "2020-07-27T12:19:33Z"
}
]
}
}{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-07-27T12:19:25Z",
"updated_at": "2020-07-2712:19:33Z",
"status": "rejected",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-07-25T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"custom_fields": {
},
"stages": [
{
"name": "initialize",
"created_at": "2020-07-27T12:19:25Z"
},
{
"name": "start",
"created_at": "2020-07-27T12:19:25Z"
},
{
"name": "submission",
"created_at": "2020-07-27T12:19:25Z"
},
{
"name": "interactive",
"created_at": "2020-07-27T12:11:17Z",
"interactive_html": " <div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'><span>Please authorize payment for total of 100.35 EUR.</span><ol> <li value=''>Payment fee.: 0.1 EUR</li><li value=''>Bank fee.: 0.25 EUR</li></ol></div>",
"interactive_fields_names": [
"confirmation_code"
],
"interactive_fields_options": null
},
{
"name": "finish",
"created_at": "2020-07-27T12:19:33Z"
}
]
}
}Providers
A provider is a Financial Institution which can execute payments. We recommend you update all of the providers’ fields at least daily.
The map with the integrated PSD2/Open Banking providers will help you to get better understanding of which banks have been integrated and find out whether your bank is already supported by Salt Edge.
Attributes
id
integer
The id of the provider
code
string
The provider’s code
name
string
The provider’s name
mode
string
The provider’s mode. Possible values: oauth, api.
status
string
The provider’s status. Possible values: active, inactive, disabled.
interactive
boolean
Whether the provider requires interactive input
instruction
string
Guidance on how to connect the provider
home_url
string
The URL of the main page of the provider
logo_url
string
The URL for the provider logo, may have a placeholder for providers with missing logos
country_code
string
Code of the provider’s country
created_at
string (date-time)
Time and date when the provider was integrated
updated_at
string (date-time)
The last time when any of the provider’s attributes were changed
payment_templates
array of strings
Identifiers of the payment templates that are supported by this provider
identification_codes
array of strings
List of codes identifying supported branches of a specific provider. It may include BLZ(Germany), ABI+CAB(Italy), Branch Codes(France) etc.
bic_codes
array of strings
List of BIC codes identifying supported branches of a specific provider.
supported_iframe_embedding
boolean
Provider can be embedded in iframe. Possible values: true, false.
id
integer
The id of the provider
code
string
The provider’s code
name
string
The provider’s name
mode
string
The provider’s mode. Possible values: oauth, api.
status
string
The provider’s status. Possible values: active, inactive, disabled.
interactive
boolean
Whether the provider requires interactive input
instruction
string
Guidance on how to connect the provider
home_url
string
The URL of the main page of the provider
logo_url
string
The URL for the provider logo, may have a placeholder for providers with missing logos
country_code
string
Code of the provider’s country
created_at
string (date-time)
Time and date when the provider was integrated
updated_at
string (date-time)
The last time when any of the provider’s attributes were changed
payment_templates
array of strings
Identifiers of the payment templates that are supported by this provider
identification_codes
array of strings
List of codes identifying supported branches of a specific provider. It may include BLZ(Germany), ABI+CAB(Italy), Branch Codes(France) etc.
bic_codes
array of strings
List of BIC codes identifying supported branches of a specific provider.
supported_iframe_embedding
boolean
Provider can be embedded in iframe. Possible values: true, false.
Sample object
{
"id": "131313131313131313",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "oauth",
"status": "active",
"interactive": true,
"instruction": "You will be securely redirected to your financial institution to authenticate.",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://www.saltedge.com/logos/providers/xf/placeholder_global.svg",
"country_code": "XF",
"identification_codes": [
"123123"
],
"bic_codes": [
"ABCDEFGH"
],
"created_at": "2020-09-15T10:57:27Z",
"updated_at": "2020-09-20T10:57:27Z",
"payment_templates": [
"FPS",
"SEPA",
"SWIFT",
"sepa_instant_payment",
"sepa_instant_payment_with_account_select"
]
}{
"id": "131313131313131313",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "oauth",
"status": "active",
"interactive": true,
"instruction": "You will be securely redirected to your financial institution to authenticate.",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://www.saltedge.com/logos/providers/xf/placeholder_global.svg",
"country_code": "XF",
"identification_codes": [
"123123"
],
"bic_codes": [
"ABCDEFGH"
],
"created_at": "2020-09-15T10:57:27Z",
"updated_at": "2020-09-20T10:57:27Z",
"payment_templates": [
"FPS",
"SEPA",
"SWIFT",
"sepa_instant_payment",
"sepa_instant_payment_with_account_select"
]
}Show
Allows you to inspect a single provider in order to give your users a proper interface to input their credentials.
The response will have an array of required_fields and interactive_fields.
Parameters
provider_code
string
The code of the provider
provider_code
string
The code of the provider
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| ProviderNotFound | 404 Not Found | The |
URL
https://www.saltedge.com/api/payments/v1/providers/{provider.code}
https://www.saltedge.com/api/payments/v1/providers/{provider.code}
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/providers/fake_client_xfcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/providers/fake_client_xfSample response
{
"data": {
"id": "131313131313131313",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "oauth",
"status": "active",
"interactive": true,
"instruction": "You will be securely redirected to your financial institution to authenticate.",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://www.saltedge.com/logos/providers/xf/placeholder_global.svg",
"country_code": "XF",
"identification_codes": [
"123123"
],
"bic_codes": [
"ABCDEFGH"
],
"supported_iframe_embedding": true,
"created_at": "2020-09-15T10:57:27Z",
"updated_at": "2020-09-20T10:57:27Z",
"payment_templates": [
"FPS",
"SEPA",
"SWIFT",
"sepa_instant_payment",
"sepa_instant_payment_with_account_select"
]
}
}{
"data": {
"id": "131313131313131313",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "oauth",
"status": "active",
"interactive": true,
"instruction": "You will be securely redirected to your financial institution to authenticate.",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://www.saltedge.com/logos/providers/xf/placeholder_global.svg",
"country_code": "XF",
"identification_codes": [
"123123"
],
"bic_codes": [
"ABCDEFGH"
],
"supported_iframe_embedding": true,
"created_at": "2020-09-15T10:57:27Z",
"updated_at": "2020-09-20T10:57:27Z",
"payment_templates": [
"FPS",
"SEPA",
"SWIFT",
"sepa_instant_payment",
"sepa_instant_payment_with_account_select"
]
}
}List
Returns all the providers we operate with.
If a provider becomes disabled, it is not included in the list.
You can read more about the next_id field in the pagination section of the reference.
Providers that require a client provider key will be included only if you have created provider keys for them.
Parameters
from_id
string, optional
The id of the record starting the next page. Defaults to null.
from_date
string (date), optional
Filtering providers by the updated_at attribute, starting from this date. Defaults to null.
country_code
string, optional
Filtering providers by country Defaults to null.
mode
string, optional
Filtering providers by mode. Possible values: oauth, api. Defaults to null.
include_fake_providers
boolean, optional
Whether you wish to fetch the fake providers Defaults to false.
template_identifier
string, optional
Return only providers that support the given payment template Defaults to null.
include_provider_fields
boolean, optional
Whether you wish to include all provider fields in the provider objects. Defaults to false.
provider_key_owner
string, optional
Filtering providers by the key owner, possible values are: client, saltedge. When the value is set as client, only providers with client-set keys will be returned. Please see Client Provider Keys.
Possible values: client, saltedge. Defaults to null.
from_id
string, optional
The id of the record starting the next page. Defaults to null.
from_date
string (date), optional
Filtering providers by the updated_at attribute, starting from this date. Defaults to null.
country_code
string, optional
Filtering providers by country Defaults to null.
mode
string, optional
Filtering providers by mode. Possible values: oauth, api. Defaults to null.
include_fake_providers
boolean, optional
Whether you wish to fetch the fake providers Defaults to false.
template_identifier
string, optional
Return only providers that support the given payment template Defaults to null.
include_provider_fields
boolean, optional
Whether you wish to include all provider fields in the provider objects. Defaults to false.
provider_key_owner
string, optional
Filtering providers by the key owner, possible values are: client, saltedge. When the value is set as client, only providers with client-set keys will be returned. Please see Client Provider Keys.
Possible values: client, saltedge. Defaults to null.
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| DateOutOfRange | 400 Bad Request | The |
| ValueOutOfRange | 400 Bad Request | Either |
URL
https://www.saltedge.com/api/payments/v1/providers
https://www.saltedge.com/api/payments/v1/providers
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/providerscurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/providersSample Response
{
"data": [
{
"id": "131313131313131313",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "oauth",
"status": "active",
"interactive": true,
"instruction": "You will be securely redirected to your financial institution to authenticate.",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://www.saltedge.com/logos/providers/xf/placeholder_global.svg",
"country_code": "XF",
"identification_codes": [
"123123"
],
"bic_codes": [
"ABCDEFGH"
],
"supported_iframe_embedding": true,
"created_at": "2020-09-15T10:57:27Z",
"updated_at": "2020-09-20T10:57:27Z",
"payment_templates": [
"FPS",
"SEPA",
"SWIFT",
"sepa_instant_payment",
"sepa_instant_payment_with_account_select"
]
}
],
"meta": {
"next_id": null,
"next_page": null
}
}{
"data": [
{
"id": "131313131313131313",
"code": "fake_client_xf",
"name": "Fake Bank with Client Keys",
"mode": "oauth",
"status": "active",
"interactive": true,
"instruction": "You will be securely redirected to your financial institution to authenticate.",
"home_url": "https://example.com",
"forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fake_client_xf",
"logo_url": "https://www.saltedge.com/logos/providers/xf/placeholder_global.svg",
"country_code": "XF",
"identification_codes": [
"123123"
],
"bic_codes": [
"ABCDEFGH"
],
"supported_iframe_embedding": true,
"created_at": "2020-09-15T10:57:27Z",
"updated_at": "2020-09-20T10:57:27Z",
"payment_templates": [
"FPS",
"SEPA",
"SWIFT",
"sepa_instant_payment",
"sepa_instant_payment_with_account_select"
]
}
],
"meta": {
"next_id": null,
"next_page": null
}
}Fake
In order to help with testing, we provide a fake country (having the country code XF) and a set of fake providers.
If your application is in the Test or Pending status,
the Connect page will let you select the fake country and its providers.
The API supplies a number of fake providers:
fake_client_xf- requires a username and a password (embedded);fake_oauth_client_xf- asks for authorization (OAuth redirect);fake_interactive_client_xf- asks for a fake SMS code in addition to a username and a password (embedded).
All the aforementioned providers require for Client Provider Keys to be set. Check the provider’s instructions in the Connect page for the appropriate credentials.
Sandboxes
We also add all sandboxes and model banks as providers to XF country. Currenly Salt Edge has the following sandboxes:
priora_demobank_xfpriora_demobank_sca_oauth_client_xfbbva_oauth_client_es_xfbcr_client_oauth_ro_xfcitibank_oauth_client_sg_xfcsas_oauth_client_cz_xfdeutsche_bank_oauth_client_de_xffineco_oauth_client_it_xfforgerock_client_gb_xfhsbc_oauth_client_gb_xfing_oauth_client_ro_xflloyds_oauth_client_gb_xfnatwest_oauth_client_gb_xfocbc_oauth_client_sg_xfozone_client_gb_xfraiffeisen_oauth_client_cz_xfraiffeisen_oauth_client_ro_xfrevolut_business_client_oauth_gb_xfrevolut_client_oauth_gb_xfstarlingbank_oauth_client_gb_xftsb_oauth_client_gb_xf
Customers
A customer represents a person who will be using your application.
You need to store the id returned from the response in your application, which is necessary when creating payments.
A Customer represents a person, an end-user, who will be using your application.
You need to store the id returned from the create response in your application, which is necessary when creating payments.
We give you the following customer API actions so that the customer will be successfully identified within Salt Edge.
Note: It is also possible to create a customer with Account Information API and then use the same customer in Payment Initiation API.
Create
Creates a customer, returning the customer object.
Parameters
identifier
string
A unique identifier of the new customer
identifier
string
A unique identifier of the new customer
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| DuplicatedCustomer | 409 Duplicated | A customer with such an |
| WrongRequestFormat | 400 Bad Request | Either an |
URL
https://www.saltedge.com/api/payments/v1/customers
https://www.saltedge.com/api/payments/v1/customers
Method
POST
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"identifier\": \"12rv1212f1efxchsdhbgv\" \
} \
}" \
https://www.saltedge.com/api/payments/v1/customerscurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X POST \
-d "{ \
\"data\": { \
\"identifier\": \"12rv1212f1efxchsdhbgv\" \
} \
}" \
https://www.saltedge.com/api/payments/v1/customersSample Response
{
"data": {
"id": "222222222222222222",
"identifier": "12rv1212f1efxchsdhbgv",
"secret": "AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8"
}
}{
"data": {
"id": "222222222222222222",
"identifier": "12rv1212f1efxchsdhbgv",
"secret": "AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8"
}
}Show
Returns the customer object.
Parameters
customer_id
integer
The id of the customer
customer_id
integer
The id of the customer
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| CustomerNotFound | 404 Not Found | Customer with such a |
URL
https://www.saltedge.com/api/payments/v1/customers/{customer.id}
https://www.saltedge.com/api/payments/v1/customers/{customer.id}
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222Sample Response
{
"data": {
"id": "222222222222222222",
"identifier": "12rv1212f1efxchsdhbgv",
"secret": "AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8"
}
}{
"data": {
"id": "222222222222222222",
"identifier": "12rv1212f1efxchsdhbgv",
"secret": "AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8"
}
}List
List all of your app’s customers. This route is available only for web applications, not mobile ones.
Parameters
identifier
string, optional
A unique identifier of a customer
identifier
string, optional
A unique identifier of a customer
Possible Errors
No specific errors
URL
https://www.saltedge.com/api/payments/v1/customers
https://www.saltedge.com/api/payments/v1/customers
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/customerscurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/customersSample Response
{
"data": [
{
"id": "222222222222222222",
"identifier": "unique_customer_identifier",
"secret": "AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8"
},
{
"id": "222222222222222223",
"identifier": "unique_customer_identifier_2",
"secret": "Ct124tk12j0129i10-1j2k124kgk1lgqvUJ8CIC80-8"
}
],
"meta": {
"next_id": "222222222222222224",
"next_page": "/api/payments/v1/customers?from_id=222222222222222224"
}
}{
"data": [
{
"id": "222222222222222222",
"identifier": "unique_customer_identifier",
"secret": "AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8"
},
{
"id": "222222222222222223",
"identifier": "unique_customer_identifier_2",
"secret": "Ct124tk12j0129i10-1j2k124kgk1lgqvUJ8CIC80-8"
}
],
"meta": {
"next_id": "222222222222222224",
"next_page": "/api/payments/v1/customers?from_id=222222222222222224"
}
}Remove
Deletes a customer, returning the customer object. This route is available only for web applications.
Parameters
customer_id
integer
The id of the customer
customer_id
integer
The id of the customer
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| CustomerLocked | 406 Not Acceptable | Current customer is locked. It can be unlocked |
| CustomerNotFound | 404 Not Found | Customer with the passed |
URL
https://www.saltedge.com/api/payments/v1/customers/{customer.id}
https://www.saltedge.com/api/payments/v1/customers/{customer.id}
Method
DELETE
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X DELETE \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X DELETE \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222Sample Response
{
"data": {
"deleted": true,
"id": "222222222222222222"
}
}{
"data": {
"deleted": true,
"id": "222222222222222222"
}
}Lock
Locks a customer and its data, returning the customer object.
All customer related data, including payments, will not be available for reading, updating or deleting even by Salt Edge. This route is available only for web applications.
Parameters
customer_id
integer
The id of the customer
customer_id
integer
The id of the customer
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| CustomerNotFound | 404 Not Found | Customer with the passed |
URL
https://www.saltedge.com/api/payments/v1/customers/{customer.id}/lock
https://www.saltedge.com/api/payments/v1/customers/{customer.id}/lock
Method
PUT
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222/lockcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222/lockSample Response
{
"data": {
"locked": true,
"id": "222222222222222222"
}
}{
"data": {
"locked": true,
"id": "222222222222222222"
}
}Unlock
Unlocks a customer and its data, returning the customer object. This route is available only for web applications.
Parameters
customer_id
integer
The id of the customer
customer_id
integer
The id of the customer
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| CustomerNotFound | 404 Not Found | Customer with the passed |
URL
https://www.saltedge.com/api/payments/v1/customers/{customer.id}/unlock
https://www.saltedge.com/api/payments/v1/customers/{customer.id}/unlock
Method
PUT
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222/unlockcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X PUT \
https://www.saltedge.com/api/payments/v1/customers/222222222222222222/unlockSample Response
{
"data": {
"unlocked": true,
"id": "222222222222222222"
}
}{
"data": {
"unlocked": true,
"id": "222222222222222222"
}
}Payments
A payment resource represents a detailed description of the particular payment.
They are meant to provide you with more information about the executed payments for further usage in technical and statistical purposes.
Attributes
id
string
The id of the payment
status
string
Possible values are:
processing– the payment order execution is in progress, more detailed information about its status can be found in the currentstage. Possiblestages- all except forfinish.accepted– the payment order was accepted by the provider. Possiblestages-finish.rejected– the payment order was rejected by the provider, and a reason is provided. Possiblestages-finish.failed– either the payment order execution failed due to an unknown reason, or the service provider returned a generic error, or the provider was down, or the provider returned an unexpected response. Possiblestages-finish.unknown– the payment order could not be confirmed to be either successful orfailed/rejectedwithin the allocated time. This status will be accompanied by theExecutionTimeouterror class. Please contact us in case you encounter this status. Possiblestages-finish.deleted– the payment was deleted. Possiblestages-finish.
created_at
string (date-time)
Time and date when the payment was made
updated_at
string (date-time)
The last time when any of the payment’s attributes were changed
id
string
The id of the payment
status
string
Possible values are:
processing– the payment order execution is in progress, more detailed information about its status can be found in the currentstage. Possiblestages- all except forfinish.accepted– the payment order was accepted by the provider. Possiblestages-finish.rejected– the payment order was rejected by the provider, and a reason is provided. Possiblestages-finish.failed– either the payment order execution failed due to an unknown reason, or the service provider returned a generic error, or the provider was down, or the provider returned an unexpected response. Possiblestages-finish.unknown– the payment order could not be confirmed to be either successful orfailed/rejectedwithin the allocated time. This status will be accompanied by theExecutionTimeouterror class. Please contact us in case you encounter this status. Possiblestages-finish.deleted– the payment was deleted. Possiblestages-finish.
created_at
string (date-time)
Time and date when the payment was made
updated_at
string (date-time)
The last time when any of the payment’s attributes were changed
Sample object
{
"data": {
"id": "131313131313131313",
"payment_attributes": {
"amount": "120",
"iban_to": "DE12345678123456781231",
"description": "test",
"currency_code": "EUR"
},
"status": "processing",
"stages": [
{
"name": "initialize",
"created_at": "2020-09-25T10:32:27Z"
},
{
"name": "start",
"created_at": "2020-09-25T10:33:27Z"
},
{
"name": "interactive",
"created_at": "2020-09-25T10:34:27Z",
"interactive_html": "<div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='iban'>\n<span>Choose and input account iban:</span>\n<ol>\n<li value='XF123456789012345678'>XF123456789012345678 (800.0 EUR)</li><li value='XF876543210987654321'>XF876543210987654321 (800.0 USD)</li>\n</ol>\n</div>\n",
"interactive_fields_names": [
"iban"
]
}
],
"created_at": "2020-09-25T10:32:27Z",
"updated_at": "2020-09-25T10:34:27Z"
}
}{
"data": {
"id": "131313131313131313",
"payment_attributes": {
"amount": "120",
"iban_to": "DE12345678123456781231",
"description": "test",
"currency_code": "EUR"
},
"status": "processing",
"stages": [
{
"name": "initialize",
"created_at": "2020-09-25T10:32:27Z"
},
{
"name": "start",
"created_at": "2020-09-25T10:33:27Z"
},
{
"name": "interactive",
"created_at": "2020-09-25T10:34:27Z",
"interactive_html": "<div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='iban'>\n<span>Choose and input account iban:</span>\n<ol>\n<li value='XF123456789012345678'>XF123456789012345678 (800.0 EUR)</li><li value='XF876543210987654321'>XF876543210987654321 (800.0 USD)</li>\n</ol>\n</div>\n",
"interactive_fields_names": [
"iban"
]
}
],
"created_at": "2020-09-25T10:32:27Z",
"updated_at": "2020-09-25T10:34:27Z"
}
}Show
Returns a single payment object.
Parameters
payment_id
string
The id of the payment
payment_id
string
The id of the payment
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| PaymentNotFound | 404 Not Found | The |
URL
https://www.saltedge.com/api/payments/v1/payments/{payment.id}
https://www.saltedge.com/api/payments/v1/payments/{payment.id}
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/payments/131313131313131313curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/payments/131313131313131313Sample response
{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-09-25T10:32:27Z",
"updated_at": "2020-09-25T10:38:27Z",
"status": "accepted",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:27Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"custom_fields": {
},
"stages": [
{
"id": "242424242424242420",
"name": "initialize",
"created_at": "2020-09-25T10:32:27Z"
},
{
"id": "242424242424242421",
"name": "start",
"created_at": "2020-09-25T10:33:27Z"
},
{
"id": "242424242424242422",
"name": "submission",
"created_at": "2020-09-25T10:34:27Z"
},
{
"id": "242424242424242423",
"name": "interactive",
"created_at": "2020-09-25T10:35:27Z",
"interactive_html": "<div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'><span>Please authorize payment for total of 100.35 EUR.</span><ol> <li value=''>Payment fee.: 0.1 EUR</li><li value=''>Bank fee.: 0.25 EUR</li></ol></div>",
"interactive_fields_names": [
"confirmation_code"
],
"interactive_fields_options": null
},
{
"id": "242424242424242424",
"name": "submission",
"created_at": "2020-09-25T10:35:27Z",
"interactive_fields": {
"iban": "XF123456789012345678",
"confirmation_code": 123456
}
},
{
"id": "242424242424242425",
"name": "settlement",
"created_at": "2020-09-25T10:36:27Z"
},
{
"id": "242424242424242426",
"name": "completed",
"created_at": "2020-09-25T10:37:27Z"
},
{
"id": "242424242424242427",
"name": "finish",
"created_at": "2020-09-25T10:38:27Z"
}
]
}
}{
"data": {
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-09-25T10:32:27Z",
"updated_at": "2020-09-25T10:38:27Z",
"status": "accepted",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:27Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"custom_fields": {
},
"stages": [
{
"id": "242424242424242420",
"name": "initialize",
"created_at": "2020-09-25T10:32:27Z"
},
{
"id": "242424242424242421",
"name": "start",
"created_at": "2020-09-25T10:33:27Z"
},
{
"id": "242424242424242422",
"name": "submission",
"created_at": "2020-09-25T10:34:27Z"
},
{
"id": "242424242424242423",
"name": "interactive",
"created_at": "2020-09-25T10:35:27Z",
"interactive_html": "<div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'><span>Please authorize payment for total of 100.35 EUR.</span><ol> <li value=''>Payment fee.: 0.1 EUR</li><li value=''>Bank fee.: 0.25 EUR</li></ol></div>",
"interactive_fields_names": [
"confirmation_code"
],
"interactive_fields_options": null
},
{
"id": "242424242424242424",
"name": "submission",
"created_at": "2020-09-25T10:35:27Z",
"interactive_fields": {
"iban": "XF123456789012345678",
"confirmation_code": 123456
}
},
{
"id": "242424242424242425",
"name": "settlement",
"created_at": "2020-09-25T10:36:27Z"
},
{
"id": "242424242424242426",
"name": "completed",
"created_at": "2020-09-25T10:37:27Z"
},
{
"id": "242424242424242427",
"name": "finish",
"created_at": "2020-09-25T10:38:27Z"
}
]
}
}List
Returns all the payments accessible to your application. The payments are sorted in ascending order of their ids, so the newest payments will come last. We recommend you fetch the whole list of payments to check whether any of the properties have changed. You can read more about next_id field in the pagination section of the reference.
Parameters
from_id
string, optional
The id of the record starting the next page. Defaults to null.
customer_id
string
The id of the customer containing the payments
from_id
string, optional
The id of the record starting the next page. Defaults to null.
customer_id
string
The id of the customer containing the payments
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| ValueOutOfRange | 400 Bad Request | Either |
URL
https://www.saltedge.com/api/payments/v1/payments?customer_id={customer.id}
https://www.saltedge.com/api/payments/v1/payments?customer_id={customer.id}
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/payments?customer_id=222222222222222222curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/payments?customer_id=222222222222222222Sample response
{
"data": [
{
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-09-10T10:57:27Z",
"updated_at": "2020-09-23T10:57:27Z",
"status": "processing",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:27Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"stages": [
{
"id": "242424242424242420",
"name": "initialize",
"created_at": "2020-09-23T10:57:27Z"
},
{
"id": "242424242424242421",
"name": "start",
"created_at": "2020-09-23T10:57:27Z"
},
{
"id": "242424242424242422",
"name": "interactive",
"created_at": "2020-09-23T10:57:27Z",
"interactive_html": "<div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='iban'><span>Choose and input account iban:</span><ol><li value='XF123456789012345678'>XF123456789012345678 (800.0 EUR)</li><li value='XF876543210987654321'>XF876543210987654321 (800.0 USD)</li></ol></div>",
"interactive_fields_names": [
"iban"
]
}
]
}
],
"meta": {
"next_id": "131313131313131314",
"next_page": "/api/payments/v1/payments?customer_id=5122311&from_id=131313131313131314"
}
}{
"data": [
{
"id": "131313131313131313",
"provider_code": "fake_client_xf",
"provider_name": "Fake Bank with Client Keys",
"customer_id": "222222222222222222",
"created_at": "2020-09-10T10:57:27Z",
"updated_at": "2020-09-23T10:57:27Z",
"status": "processing",
"template_identifier": "SEPA",
"payment_attributes": {
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:27Z",
"customer_ip_address": "10.0.0.1",
"customer_device_os": "iOS 11",
"creditor_name": "Jay Dawson",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_country_code": "UK",
"currency_code": "GBP",
"amount": "199000.00",
"description": "Stocks purchase",
"creditor_iban": "GB33BUKB20201555555555"
},
"stages": [
{
"id": "242424242424242420",
"name": "initialize",
"created_at": "2020-09-23T10:57:27Z"
},
{
"id": "242424242424242421",
"name": "start",
"created_at": "2020-09-23T10:57:27Z"
},
{
"id": "242424242424242422",
"name": "interactive",
"created_at": "2020-09-23T10:57:27Z",
"interactive_html": "<div id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='iban'><span>Choose and input account iban:</span><ol><li value='XF123456789012345678'>XF123456789012345678 (800.0 EUR)</li><li value='XF876543210987654321'>XF876543210987654321 (800.0 USD)</li></ol></div>",
"interactive_fields_names": [
"iban"
]
}
]
}
],
"meta": {
"next_id": "131313131313131314",
"next_page": "/api/payments/v1/payments?customer_id=5122311&from_id=131313131313131314"
}
}Remove
Removes a payment from our system.
It is possible to remove only payments where the last stage is finished.
Parameters
payment_id
string
The id of the payment
payment_id
string
The id of the payment
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| PaymentNotFinished | 406 Not Acceptable | There was an attempt to remove a payment before it is finished i.e. its |
| PaymentNotFound | 404 Not Found | The |
URL
https://www.saltedge.com/api/payments/v1/payments/{payment.id}
https://www.saltedge.com/api/payments/v1/payments/{payment.id}
Method
DELETE
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X DELETE \
https://www.saltedge.com/api/payments/v1/payments/131313131313131313curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X DELETE \
https://www.saltedge.com/api/payments/v1/payments/131313131313131313Sample Response
{
"data": {
"id": "131313131313131313",
"removed": true
}
}{
"data": {
"id": "131313131313131313",
"removed": true
}
}Stages
The following represents the objects you get in the stages field of the payment object.
id
string
The id of the stage
name
string
The name of the stage. Possible values:
initialize- the payment object was createdstart- the payment process has just beguninteractive- waiting for the interactive inputsubmission- preparing a payment initiation request for submission to the financial institutionsettlement- payment initiation request accepted by the financial institution, waiting for settlement to completecompleted- payment initiation settlement has been completed, funds have been sentfinish- wrapping up the payment process.
interactive_html
string, optional
HTML code that shows the current interactive state of the payment. Appears only for the interactive providers
interactive_fields_names
array of strings, optional
The interactive fields that are currently required by the provider of the payment. Appears only for the interactive providers
error_class
string, optional
Error class name. Appears only when an error occurs
message
string, optional
Brief error description. Appears only when an error occurs
created_at
string (date-time)
Time and date when the stage was created.
id
string
The id of the stage
name
string
The name of the stage. Possible values:
initialize- the payment object was createdstart- the payment process has just beguninteractive- waiting for the interactive inputsubmission- preparing a payment initiation request for submission to the financial institutionsettlement- payment initiation request accepted by the financial institution, waiting for settlement to completecompleted- payment initiation settlement has been completed, funds have been sentfinish- wrapping up the payment process.
interactive_html
string, optional
HTML code that shows the current interactive state of the payment. Appears only for the interactive providers
interactive_fields_names
array of strings, optional
The interactive fields that are currently required by the provider of the payment. Appears only for the interactive providers
error_class
string, optional
Error class name. Appears only when an error occurs
message
string, optional
Brief error description. Appears only when an error occurs
created_at
string (date-time)
Time and date when the stage was created.
Possible Service Errors
During the finish stage the following errors might occur.
| Error name | HTTP code | Description |
|---|---|---|
| ConnectionFailed | 406 Not Acceptable | Some network errors appeared while fetching data |
| ExecutionTimeout | 406 Not Acceptable | It took too long to execute the payment |
| InteractiveAdapterTimeout | 406 Not Acceptable | The customer hasn’t completed the interactive step of the payment in time |
| InvalidCredentials | 406 Not Acceptable | The customer tried to initiate a payment with the wrong credentials |
| InvalidInteractiveCredentials | 406 Not Acceptable | The customer entered wrong credentials during the interactive step of the payment |
| PaymentFailed | 406 Not Acceptable | Failed to create the payment |
| ProviderUnavailable | 406 Not Acceptable | At the moment, the provider is unavailable for some reason |
Templates
A payment template resource contains a set of required and optional fields that need to be filled in order to successfully execute a payment. Different payment templates serve different purposes.
Attributes
id
string
The id of the payment template
identifier
string
Unique identifier of the payment template
description
string
Additional information related to the template
deprecated
boolean
Whether the payment template is deprecated or not. Deprecated payment templates will be removed in the next API version.
created_at
string (date-time)
Time and date when the payment template was added
updated_at
string (date-time)
The last time when any of the template’s attributes were changed
id
string
The id of the payment template
identifier
string
Unique identifier of the payment template
description
string
Additional information related to the template
deprecated
boolean
Whether the payment template is deprecated or not. Deprecated payment templates will be removed in the next API version.
created_at
string (date-time)
Time and date when the payment template was added
updated_at
string (date-time)
The last time when any of the template’s attributes were changed
Sample object
{
"data": {
"id": "131313131313131313",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z",
"payment_fields": [
{
"id": "363636363636363630",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363631",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363632",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363635",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363636",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363637",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363638",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363639",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363640",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363641",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363642",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363643",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363644",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363645",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363646",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363647",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363648",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363649",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363650",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363651",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363652",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363653",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363654",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363655",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363656",
"payment_template_id": "29",
"name": "end_to_end_id",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363657",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363658",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363659",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363660",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363661",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "36363636363636363662",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363663",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
}
]
}
}{
"data": {
"id": "131313131313131313",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z",
"payment_fields": [
{
"id": "363636363636363630",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363631",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363632",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363635",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363636",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363637",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "363636363636363638",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363639",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363640",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363641",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363642",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363643",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363644",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363645",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363646",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363647",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363648",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363649",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363650",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363651",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363652",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363653",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363654",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363655",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363656",
"payment_template_id": "29",
"name": "end_to_end_id",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363657",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363658",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363659",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363660",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363661",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "36363636363636363662",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
},
{
"id": "36363636363636363663",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:27Z",
"updated_at": "2020-09-22T10:57:27Z"
}
]
}
}Show
Returns a single payment template object.
Parameters
template_identifier
string
The requested template identifier
template_identifier
string
The requested template identifier
Possible Errors
| Error name | HTTP code | Description |
|---|---|---|
| PaymentTemplateNotFound | 404 Not Found | No payment template was found by the passed template |
URL
https://www.saltedge.com/api/payments/v1/templates/{template.identifier}
https://www.saltedge.com/api/payments/v1/templates/{template.identifier}
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/templates/SEPAcurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/templates/SEPASample response
{
"data": {
"id": "131313131313131313",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"payment_fields": [
{
"id": "363636363636363630",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363631",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363632",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "363636363636363634",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363635",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363636",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363637",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363638",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "3636363636363636339",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363640",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363641",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363642",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363643",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363644",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363645",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363646",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363647",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363648",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363649",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363650",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363651",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363652",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363653",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363654",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363655",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363656",
"payment_template_id": "29",
"name": "end_to_end_id",
"reference": "p:1928384756",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363657",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363658",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363659",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363660",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363661",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "363636363636363662",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363663",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
}
]
}
}{
"data": {
"id": "131313131313131313",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"payment_fields": [
{
"id": "363636363636363630",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363631",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363632",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "363636363636363634",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363635",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363636",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363637",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363638",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "3636363636363636339",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363640",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363641",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363642",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363643",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363644",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363645",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363646",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363647",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363648",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363649",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363650",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363651",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363652",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363653",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363654",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363655",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363656",
"payment_template_id": "29",
"name": "end_to_end_id",
"reference": "p:1928384756",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363657",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363658",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363659",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363660",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363661",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "363636363636363662",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363663",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
}
]
}
}List
Returns all the available payment templates.
Parameters
from_id
string, optional
The id of the record starting the next page. Defaults to null.
deprecated
boolean, optional
Filtering payment templates by deprecation. All the supported payment templates will be returned if no value was set.
from_id
string, optional
The id of the record starting the next page. Defaults to null.
deprecated
boolean, optional
Filtering payment templates by deprecation. All the supported payment templates will be returned if no value was set.
Possible Errors
No specific errors
URL
https://www.saltedge.com/api/payments/v1/templates
https://www.saltedge.com/api/payments/v1/templates
Method
GET
Sample request
curl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/templatescurl -v -H "Accept: application/json" \
-H "Content-type: application/json" \
-H "App-id: $APP_ID" \
-H "Secret: $SECRET" \
-X GET \
https://www.saltedge.com/api/payments/v1/templatesSample response
{
"data": {
"id": "131313131313131313",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"payment_fields": [
{
"id": "363636363636363630",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363631",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363632",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "363636363636363634",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363635",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363636",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363637",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363638",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363639",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363640",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363641",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363642",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363643",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363644",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363645",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363646",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363647",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363648",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363649",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363650",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363651",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363652",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363653",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363654",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363655",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363656",
"payment_template_id": "29",
"name": "end_to_end_id",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363657",
"payment_template_id": "29",
"name": "reference",
"english_name": "Payment Reference",
"localized_name": "Payment Reference",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363658",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363659",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363660",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363661",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363662",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "363636363636363663",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363664",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
}
]
}
}{
"data": {
"id": "131313131313131313",
"identifier": "SEPA",
"description": "SEPA Payment",
"deprecated": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"payment_fields": [
{
"id": "363636363636363630",
"payment_template_id": "29",
"name": "amount",
"english_name": "Amount",
"localized_name": "Amount",
"nature": "number",
"position": 29,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363631",
"payment_template_id": "29",
"name": "debtor_iban",
"english_name": "Debtor IBAN",
"localized_name": "Debtor IBAN",
"nature": "text",
"position": 30,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363632",
"payment_template_id": "29",
"name": "creditor_iban",
"english_name": "Creditor IBAN",
"localized_name": "Creditor IBAN",
"nature": "text",
"position": 31,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363633",
"payment_template_id": "29",
"name": "mode",
"english_name": "Mode",
"localized_name": "Mode",
"nature": "select",
"position": 33,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "NORMAL",
"english_name": "NORMAL",
"localized_name": "NORMAL",
"option_value": "NORMAL",
"selected": true
},
{
"name": "INSTANT",
"english_name": "INSTANT",
"localized_name": "INSTANT",
"option_value": "INSTANT",
"selected": false
}
]
},
{
"id": "363636363636363634",
"payment_template_id": "29",
"name": "debtor_region",
"english_name": "Debtor Region",
"localized_name": "Debtor Region",
"nature": "text",
"position": 14,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363635",
"payment_template_id": "29",
"name": "creditor_agent",
"english_name": "Creditor Agent ID",
"localized_name": "Creditor Agent ID",
"nature": "text",
"position": 17,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363636",
"payment_template_id": "29",
"name": "customer_ip_address",
"english_name": "Customer IP Address",
"localized_name": "Customer IP Address",
"nature": "text",
"position": 2,
"extra": {
"validation_regexp": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363637",
"payment_template_id": "29",
"name": "debtor_name",
"english_name": "Debtor Name",
"localized_name": "Debtor Name",
"nature": "text",
"position": 8,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363638",
"payment_template_id": "29",
"name": "creditor_name",
"english_name": "Creditor Name",
"localized_name": "Creditor Name",
"nature": "text",
"position": 16,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363639",
"payment_template_id": "29",
"name": "creditor_address",
"english_name": "Creditor Address",
"localized_name": "Creditor Address",
"nature": "text",
"position": 19,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363640",
"payment_template_id": "29",
"name": "debtor_building_number",
"english_name": "Debtor Building Number",
"localized_name": "Debtor Building Number",
"nature": "text",
"position": 11,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363641",
"payment_template_id": "29",
"name": "customer_longitude",
"english_name": "Customer Longitude",
"localized_name": "Customer Longitude",
"nature": "number",
"position": 7,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363642",
"payment_template_id": "29",
"name": "debtor_town",
"english_name": "Debtor Town",
"localized_name": "Debtor Town",
"nature": "text",
"position": 13,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363643",
"payment_template_id": "29",
"name": "creditor_agent_name",
"english_name": "Creditor Agent Name",
"localized_name": "Creditor Agent Name",
"nature": "text",
"position": 18,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363644",
"payment_template_id": "29",
"name": "creditor_street_name",
"english_name": "Creditor Street Name",
"localized_name": "Creditor Street Name",
"nature": "text",
"position": 20,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363645",
"payment_template_id": "29",
"name": "creditor_building_number",
"english_name": "Creditor Building Number",
"localized_name": "Creditor Building Number",
"nature": "text",
"position": 21,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363646",
"payment_template_id": "29",
"name": "creditor_post_code",
"english_name": "Creditor Post Code",
"localized_name": "Creditor Post Code",
"nature": "text",
"position": 22,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363647",
"payment_template_id": "29",
"name": "creditor_town",
"english_name": "Creditor Town",
"localized_name": "Creditor Town",
"nature": "text",
"position": 23,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363648",
"payment_template_id": "29",
"name": "creditor_region",
"english_name": "Creditor Region",
"localized_name": "Creditor Region",
"nature": "text",
"position": 24,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363649",
"payment_template_id": "29",
"name": "creditor_country_code",
"english_name": "Creditor Country Code",
"localized_name": "Creditor Country Code",
"nature": "text",
"position": 25,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363650",
"payment_template_id": "29",
"name": "date",
"english_name": "Payment Date",
"localized_name": "Payment Date",
"nature": "text",
"position": 26,
"extra": {
"validation_regexp": "^\\d{4}-\\d{2}-\\d{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363651",
"payment_template_id": "29",
"name": "time",
"english_name": "Payment Time",
"localized_name": "Payment Time",
"nature": "text",
"position": 27,
"extra": {
"validation_regexp": "^\\d{2}:\\d{2}(:\\d{2})?$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363652",
"payment_template_id": "29",
"name": "customer_ip_port",
"english_name": "Customer IP Port",
"localized_name": "Customer IP Port",
"nature": "number",
"position": 3,
"extra": {
"validation_regexp": "^\\d{1,5}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363653",
"payment_template_id": "29",
"name": "customer_device_os",
"english_name": "Customer Device OS",
"localized_name": "Customer Device OS",
"nature": "text",
"position": 4,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363654",
"payment_template_id": "29",
"name": "customer_latitude",
"english_name": "Customer Latitude",
"localized_name": "Customer Latitude",
"nature": "number",
"position": 6,
"extra": {
"validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363655",
"payment_template_id": "29",
"name": "description",
"english_name": "Description",
"localized_name": "Description",
"nature": "text",
"position": 28,
"extra": {
"validation_regexp": "^.{2,1000}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363656",
"payment_template_id": "29",
"name": "end_to_end_id",
"english_name": "End to End Identification",
"localized_name": "End to End Identification",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363657",
"payment_template_id": "29",
"name": "reference",
"english_name": "Payment Reference",
"localized_name": "Payment Reference",
"nature": "text",
"position": 0,
"extra": {
"validation_regexp": "^.{1,35}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363658",
"payment_template_id": "29",
"name": "debtor_address",
"english_name": "Debtor Address",
"localized_name": "Debtor Address",
"nature": "text",
"position": 9,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363659",
"payment_template_id": "29",
"name": "debtor_street_name",
"english_name": "Debtor Street Name",
"localized_name": "Debtor Street Name",
"nature": "text",
"position": 10,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363660",
"payment_template_id": "29",
"name": "debtor_post_code",
"english_name": "Debtor Post Code",
"localized_name": "Debtor Post Code",
"nature": "text",
"position": 12,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363661",
"payment_template_id": "29",
"name": "debtor_country_code",
"english_name": "Debtor Country Code",
"localized_name": "Debtor Country Code",
"nature": "text",
"position": 15,
"extra": {
"validation_regexp": "^[A-Z]{2}$"
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363662",
"payment_template_id": "29",
"name": "currency_code",
"english_name": "Currency",
"localized_name": "Currency",
"nature": "select",
"position": 32,
"extra": {
"validation_regexp": ""
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z",
"field_options": [
{
"name": "EUR",
"english_name": "EUR",
"localized_name": "EUR",
"option_value": "EUR",
"selected": true
}
]
},
{
"id": "363636363636363663",
"payment_template_id": "29",
"name": "customer_user_agent",
"english_name": "Customer User Agent",
"localized_name": "Customer User Agent",
"nature": "text",
"position": 5,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
},
{
"id": "363636363636363664",
"payment_template_id": "29",
"name": "customer_last_logged_at",
"english_name": "Customer Last Logged At",
"localized_name": "Customer Last Logged At",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": ""
},
"optional": true,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
}
]
}
}Payment fields
There are several types of fields as marked by their nature attribute.
id
string
The id of the payment field
name
string, optional
The field’s name that should be used as a key in the credentials object
english_name
string, optional
The field’s name in US English
localized_name
string, optional
The field’s name in the provider’s main language
nature
string, optional
Nature Possible values: text, password, select, file, number, dynamic_select.
position
integer, optional
The field’s position in the public user interface
optional
boolean, optional
Whether the input for this field is optional or not
field_options
object, optional
Only for the select field type. Contains the options for the select
created_at
string (date-time)
Time and date when the payment field was added
updated_at
string (date-time)
The last time when any of the payment field’s attributes were changed
id
string
The id of the payment field
name
string, optional
The field’s name that should be used as a key in the credentials object
english_name
string, optional
The field’s name in US English
localized_name
string, optional
The field’s name in the provider’s main language
nature
string, optional
Nature Possible values: text, password, select, file, number, dynamic_select.
position
integer, optional
The field’s position in the public user interface
optional
boolean, optional
Whether the input for this field is optional or not
field_options
object, optional
Only for the select field type. Contains the options for the select
created_at
string (date-time)
Time and date when the payment field was added
updated_at
string (date-time)
The last time when any of the payment field’s attributes were changed
Sample object
{
"id": "131313131313131313",
"payment_template_id": "2",
"name": "iban_from",
"english_name": "IBAN from",
"localized_name": "IBAN from",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
}{
"id": "131313131313131313",
"payment_template_id": "2",
"name": "iban_from",
"english_name": "IBAN from",
"localized_name": "IBAN from",
"nature": "text",
"position": 1,
"extra": {
"validation_regexp": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[A-Z0-9]{7}([a-zA-Z0-9]?){0,16}$"
},
"optional": false,
"created_at": "2020-09-22T10:57:28Z",
"updated_at": "2020-09-22T10:57:28Z"
}Extra
The following represents the object you get in the extra field of the payment field object.
Note: You may or may not have all of the fields listed below.
validation_regexp
string, optional
The regexp used for the payment field validation
validation_regexp
string, optional
The regexp used for the payment field validation
Common attributes
end_to_end_id
string
An internal identifier used by the merchants and not accesible/visible to the end-user
reference
string, optional
An external identifier which is visible to the end-user (e.g. tracking number, order number, bill number, etc)
customer_last_logged_at
string (date-time), optional
Time when the customer was last logged in
customer_ip_address
string
IP address of the customer
customer_ip_port
string, optional
IP port of the customer
customer_device_os
string, optional
The operating system of the customer
customer_user_agent
string, optional
The user-agent of the customer
customer_latitude
string, optional
Defines the customer’s location
customer_longitude
string, optional
Defines the customer’s location
debtor_name
string, optional
The full name of the debtor (payer)
debtor_address
string, optional
The full address of the debtor
debtor_street_name
string, optional
The street name of the debtor
debtor_building_number
string, optional
The building number of the debtor
debtor_post_code
string, optional
The post code of the debtor
debtor_town
string, optional
The name of the town/city of the debtor
debtor_region
string, optional
The name of the country/region of the debtor
debtor_country_code
string, optional
The ISO code of the debtor’s country
creditor_name
string
The full name of the creditor (payee)
creditor_agent
string, optional
The id of the creditor’s agent
creditor_agent_name
string, optional
The name of the creditor’s agent
creditor_address
string, optional
The full address of the creditor
creditor_street_name
string, optional
The street name of the creditor
creditor_building_number
string, optional
The building number of the creditor
creditor_post_code
string, optional
The post code of the creditor
creditor_town
string, optional
The name of the town/city of the creditor
creditor_region
string, optional
The name of the country/region of the creditor
creditor_country_code
string
The ISO code of the creditor’s country
amount
string
Payment amount in the specified currency
description
string
The unstructured description of the payment
purpose_code
string, optional
ISO 18245 purpose code
date
string (date), optional
The date when to execute the payment. Defaults to the current date.
time
string (time), optional
The precise time when to execute the payment. Defaults to the current time.
end_to_end_id
string
An internal identifier used by the merchants and not accesible/visible to the end-user
reference
string, optional
An external identifier which is visible to the end-user (e.g. tracking number, order number, bill number, etc)
customer_last_logged_at
string (date-time), optional
Time when the customer was last logged in
customer_ip_address
string
IP address of the customer
customer_ip_port
string, optional
IP port of the customer
customer_device_os
string, optional
The operating system of the customer
customer_user_agent
string, optional
The user-agent of the customer
customer_latitude
string, optional
Defines the customer’s location
customer_longitude
string, optional
Defines the customer’s location
debtor_name
string, optional
The full name of the debtor (payer)
debtor_address
string, optional
The full address of the debtor
debtor_street_name
string, optional
The street name of the debtor
debtor_building_number
string, optional
The building number of the debtor
debtor_post_code
string, optional
The post code of the debtor
debtor_town
string, optional
The name of the town/city of the debtor
debtor_region
string, optional
The name of the country/region of the debtor
debtor_country_code
string, optional
The ISO code of the debtor’s country
creditor_name
string
The full name of the creditor (payee)
creditor_agent
string, optional
The id of the creditor’s agent
creditor_agent_name
string, optional
The name of the creditor’s agent
creditor_address
string, optional
The full address of the creditor
creditor_street_name
string, optional
The street name of the creditor
creditor_building_number
string, optional
The building number of the creditor
creditor_post_code
string, optional
The post code of the creditor
creditor_town
string, optional
The name of the town/city of the creditor
creditor_region
string, optional
The name of the country/region of the creditor
creditor_country_code
string
The ISO code of the creditor’s country
amount
string
Payment amount in the specified currency
description
string
The unstructured description of the payment
purpose_code
string, optional
ISO 18245 purpose code
date
string (date), optional
The date when to execute the payment. Defaults to the current date.
time
string (time), optional
The precise time when to execute the payment. Defaults to the current time.
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-07-27",
"time": "10:20:30"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-07-27",
"time": "10:20:30"
}Supported templates
Here you will find the list of all the currently supported payment templates.
Faster Payment
This payment template is enabled by passing the template_identifier with the value “FPS” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment Defaults to GBP.
debtor_sort_code
string, optional
The debtor’s bank sort code
debtor_account_number
string, optional
The debtor’s bank account number
creditor_sort_code
string
The creditor’s bank sort code
creditor_account_number
string
The creditor’s bank account number
currency_code
string
The currency of the payment Defaults to GBP.
debtor_sort_code
string, optional
The debtor’s bank sort code
debtor_account_number
string, optional
The debtor’s bank account number
creditor_sort_code
string
The creditor’s bank sort code
creditor_account_number
string
The creditor’s bank account number
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lewis Begum",
"debtor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"debtor_street_name": "One Canada Square",
"debtor_building_number": "One",
"debtor_post_code": "E14 5AB",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "George Clayton",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "40 King Street West, Suite 2100, Toronto, Ontario M5H3C2, Canada",
"creditor_street_name": "King Street West",
"creditor_building_number": "40",
"creditor_post_code": "M5H3C2",
"creditor_town": "Toronto",
"creditor_region": "Canada",
"creditor_country_code": "CA",
"amount": "199000.99",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "12345678",
"mode": "STANDARD"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lewis Begum",
"debtor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"debtor_street_name": "One Canada Square",
"debtor_building_number": "One",
"debtor_post_code": "E14 5AB",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "George Clayton",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "40 King Street West, Suite 2100, Toronto, Ontario M5H3C2, Canada",
"creditor_street_name": "King Street West",
"creditor_building_number": "40",
"creditor_post_code": "M5H3C2",
"creditor_town": "Toronto",
"creditor_region": "Canada",
"creditor_country_code": "CA",
"amount": "199000.99",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "12345678",
"mode": "STANDARD"
}BACS
This payment template is enabled by passing the template_identifier with the value “BACS” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to GBP.
debtor_sort_code
string, optional
The debtor’s bank sort code
debtor_account_number
string, optional
The debtor’s bank account number
creditor_sort_code
string
The creditor’s bank sort code
creditor_account_number
string
The creditor’s bank account number
currency_code
string
The currency of the payment. Defaults to GBP.
debtor_sort_code
string, optional
The debtor’s bank sort code
debtor_account_number
string, optional
The debtor’s bank account number
creditor_sort_code
string
The creditor’s bank sort code
creditor_account_number
string
The creditor’s bank account number
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "GBP",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_sort_code": "40-47-84",
"debtor_account_number": "70872490",
"creditor_sort_code": "56-00-03",
"creditor_account_number": "13354647"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "GBP",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_sort_code": "40-47-84",
"debtor_account_number": "70872490",
"creditor_sort_code": "56-00-03",
"creditor_account_number": "13354647"
}CHAPS
This payment template is enabled by passing the template_identifier with the value “CHAPS” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to GBP.
debtor_sort_code
string, optional
The debtor’s bank sort code
debtor_account_number
string, optional
The debtor’s bank account number
creditor_sort_code
string
The creditor’s bank sort code
creditor_account_number
string
The creditor’s bank account number
currency_code
string
The currency of the payment. Defaults to GBP.
debtor_sort_code
string, optional
The debtor’s bank sort code
debtor_account_number
string, optional
The debtor’s bank account number
creditor_sort_code
string
The creditor’s bank sort code
creditor_account_number
string
The creditor’s bank account number
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "GBP",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_sort_code": "40-47-84",
"debtor_account_number": "70872490",
"creditor_sort_code": "56-00-03",
"creditor_account_number": "13354647"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "GBP",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_sort_code": "40-47-84",
"debtor_account_number": "70872490",
"creditor_sort_code": "56-00-03",
"creditor_account_number": "13354647"
}SEPA
This payment template is enabled by passing the template_identifier with the value “SEPA” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
mode
string, optional
This attribute has been deprecated and will not be used. If you need to initiate an instant SEPA payment please see the SEPA Instant template.
Possible values: NORMAL, INSTANT. Defaults to NORMAL.
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
mode
string, optional
This attribute has been deprecated and will not be used. If you need to initiate an instant SEPA payment please see the SEPA Instant template.
Possible values: NORMAL, INSTANT. Defaults to NORMAL.
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555",
"mode": "NORMAL"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555",
"mode": "NORMAL"
}SEPA Instant
This payment template is enabled by passing template_identifier with value “SEPA_INSTANT” in Pay with Connect or Pay with Direct API endpoints.
This template has all common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:1928384756",
"customer_last_logged_at": "2018-11-21T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2018-11-20",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555"
}{
"end_to_end_id": "#123123123",
"reference": "p:1928384756",
"customer_last_logged_at": "2018-11-21T13:48:40Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2018-11-20",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555"
}Target2
This payment template is enabled by passing the template_identifier with the value “TARGET2” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555"
}HSVP
This payment template is enabled by passing the template_identifier with the value “HSVP” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
currency_code
string
The currency of the payment. Defaults to EUR.
debtor_iban
string, optional
The debtor’s IBAN
creditor_iban
string
The creditor’s IBAN
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_iban": "DE75512108001245126199",
"creditor_iban": "GB33BUKB20201555555555"
}ELIXIR
This payment template is enabled by passing the template_identifier with the value “ELIXIR” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to PLN.
debtor_account_number
string, optional
The debtor’s account number
creditor_account_number
string
The creditor’s account number
mode
string
Possible values: STANDARD, EXPRESS. Defaults to STANDARD.
currency_code
string
The currency of the payment. Defaults to PLN.
debtor_account_number
string, optional
The debtor’s account number
creditor_account_number
string
The creditor’s account number
mode
string
Possible values: STANDARD, EXPRESS. Defaults to STANDARD.
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lewis Begum",
"debtor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"debtor_street_name": "One Canada Square",
"debtor_building_number": "One",
"debtor_post_code": "E14 5AB",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "George Clayton",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "40 King Street West, Suite 2100, Toronto, Ontario M5H3C2, Canada",
"creditor_street_name": "King Street West",
"creditor_building_number": "40",
"creditor_post_code": "M5H3C2",
"creditor_town": "Toronto",
"creditor_region": "Canada",
"creditor_country_code": "CA",
"amount": "199000.99",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "12345678",
"mode": "STANDARD"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lewis Begum",
"debtor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"debtor_street_name": "One Canada Square",
"debtor_building_number": "One",
"debtor_post_code": "E14 5AB",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "George Clayton",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "40 King Street West, Suite 2100, Toronto, Ontario M5H3C2, Canada",
"creditor_street_name": "King Street West",
"creditor_building_number": "40",
"creditor_post_code": "M5H3C2",
"creditor_town": "Toronto",
"creditor_region": "Canada",
"creditor_country_code": "CA",
"amount": "199000.99",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "12345678",
"mode": "STANDARD"
}Blue Cash
This payment template is enabled by passing the template_identifier with the value “BLUE_CASH” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to PLN.
debtor_account_number
string, optional
The debtor’s bank account number
creditor_account_number
string
The creditor’s bank account number
currency_code
string
The currency of the payment. Defaults to PLN.
debtor_account_number
string, optional
The debtor’s bank account number
creditor_account_number
string
The creditor’s bank account number
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2018-11-20",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "13354647"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2018-11-20",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "13354647"
}Sorbnet
This payment template is enabled by passing the template_identifier with the value “SORBNET” in Pay with Connect or Pay with Direct API endpoints.
This template has all common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to PLN.
debtor_account_number
string, optional
The debtor’s bank account number
creditor_account_number
string
The creditor’s bank account number
currency_code
string
The currency of the payment. Defaults to PLN.
debtor_account_number
string, optional
The debtor’s bank account number
creditor_account_number
string
The creditor’s bank account number
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "13354647"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Riley Atkins",
"debtor_address": "2 Irving Grove, London SW9 9HL, UK",
"debtor_street_name": "Irving Grove",
"debtor_building_number": "2",
"debtor_post_code": "SW9 9HL",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "PLN",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "13354647"
}SWIFT
This payment template is enabled by passing the template_identifier with the value “SWIFT” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to USD.
debtor_account_number
string, optional
The debtor’s account number
creditor_account_number
string
The creditor’s account number
creditor_bank_swift_code
string
The creditor’s bank SWIFT code
creditor_bank_name
string
The creditor’s bank name
creditor_bank_address
string, optional
The creditor’s bank full address
creditor_bank_street_name
string
The creditor’s bank street name
creditor_bank_building_number
string
The creditor’s bank building number
creditor_bank_post_code
string
The creditor’s bank post code
creditor_bank_town
string
The creditor’s bank town/city
creditor_bank_region
string, optional
The creditor’s bank country/region
creditor_bank_country_code
string
The creditor’s bank ISO country code
correspondent_account_number
string, optional
The correspondent’s account number
correspondent_bank_name
string, optional
The correspondent’s bank name
correspondent_bank_address
string, optional
The correspondent’s bank full address
correspondent_bank_swift_code
string, optional
The correspondent’s bank SWIFT code
charge_bearer
string, optional
Possible values: CREDITOR, DEBTOR, SHARED. Defaults to CREDITOR.
priority
string, optional
Possible values: NORMAL, URGENT, SYSTEM. Defaults to NORMAL.
currency_code
string
The currency of the payment. Defaults to USD.
debtor_account_number
string, optional
The debtor’s account number
creditor_account_number
string
The creditor’s account number
creditor_bank_swift_code
string
The creditor’s bank SWIFT code
creditor_bank_name
string
The creditor’s bank name
creditor_bank_address
string, optional
The creditor’s bank full address
creditor_bank_street_name
string
The creditor’s bank street name
creditor_bank_building_number
string
The creditor’s bank building number
creditor_bank_post_code
string
The creditor’s bank post code
creditor_bank_town
string
The creditor’s bank town/city
creditor_bank_region
string, optional
The creditor’s bank country/region
creditor_bank_country_code
string
The creditor’s bank ISO country code
correspondent_account_number
string, optional
The correspondent’s account number
correspondent_bank_name
string, optional
The correspondent’s bank name
correspondent_bank_address
string, optional
The correspondent’s bank full address
correspondent_bank_swift_code
string, optional
The correspondent’s bank SWIFT code
charge_bearer
string, optional
Possible values: CREDITOR, DEBTOR, SHARED. Defaults to CREDITOR.
priority
string, optional
Possible values: NORMAL, URGENT, SYSTEM. Defaults to NORMAL.
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lewis Begum",
"debtor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"debtor_street_name": "One Canada Square",
"debtor_building_number": "One",
"debtor_post_code": "E14 5AB",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "George Clayton",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "40 King Street West, Suite 2100, Toronto, Ontario M5H3C2, Canada",
"creditor_street_name": "King Street West",
"creditor_building_number": "40",
"creditor_post_code": "M5H3C2",
"creditor_town": "Toronto",
"creditor_region": "Canada",
"creditor_country_code": "CA",
"amount": "199000.99",
"currency_code": "USD",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "12345678",
"creditor_bank_swift_code": "TDOMCATTTOR",
"creditor_bank_name": "Toronto Dominion Bank",
"creditor_bank_address": "1547 Merivale Road, Nepean, Ontario, K2G 4V3, Canada",
"creditor_bank_street_name": "Merivale Road",
"creditor_bank_building_number": "1547",
"creditor_bank_post_code": "K2G 4V3",
"creditor_bank_town": "Nepean",
"creditor_bank_region": "Ontario",
"creditor_bank_country_code": "CA",
"correspondent_account_number": "026-009-593",
"correspondent_bank_name": "Bank of America",
"correspondent_bank_address": "New York",
"correspondent_bank_swift_code": "BOFAUS3NXXX",
"charge_bearer": "CREDITOR",
"priority": "NORMAL"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lewis Begum",
"debtor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"debtor_street_name": "One Canada Square",
"debtor_building_number": "One",
"debtor_post_code": "E14 5AB",
"debtor_town": "London",
"debtor_region": "England",
"debtor_country_code": "UK",
"creditor_name": "George Clayton",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "40 King Street West, Suite 2100, Toronto, Ontario M5H3C2, Canada",
"creditor_street_name": "King Street West",
"creditor_building_number": "40",
"creditor_post_code": "M5H3C2",
"creditor_town": "Toronto",
"creditor_region": "Canada",
"creditor_country_code": "CA",
"amount": "199000.99",
"currency_code": "USD",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_account_number": "70872490",
"creditor_account_number": "12345678",
"creditor_bank_swift_code": "TDOMCATTTOR",
"creditor_bank_name": "Toronto Dominion Bank",
"creditor_bank_address": "1547 Merivale Road, Nepean, Ontario, K2G 4V3, Canada",
"creditor_bank_street_name": "Merivale Road",
"creditor_bank_building_number": "1547",
"creditor_bank_post_code": "K2G 4V3",
"creditor_bank_town": "Nepean",
"creditor_bank_region": "Ontario",
"creditor_bank_country_code": "CA",
"correspondent_account_number": "026-009-593",
"correspondent_bank_name": "Bank of America",
"correspondent_bank_address": "New York",
"correspondent_bank_swift_code": "BOFAUS3NXXX",
"charge_bearer": "CREDITOR",
"priority": "NORMAL"
}Visa
This payment template is enabled by passing the template_identifier with the value “VISA” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to USD.
debtor_PAN
string, optional
The debtor’s PAN
creditor_pan
string
The creditor’s PAN
currency_code
string
The currency of the payment. Defaults to USD.
debtor_PAN
string, optional
The debtor’s PAN
creditor_pan
string
The creditor’s PAN
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_pan": "1111222233334444",
"creditor_pan": "4444333322221111"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_pan": "1111222233334444",
"creditor_pan": "4444333322221111"
}Mastercard
This payment template is enabled by passing the template_identifier with the value “MASTERCARD” in Pay with Connect or Pay with Direct API endpoints.
This template has all the common attributes + the following specific attributes:
currency_code
string
The currency of the payment. Defaults to USD.
debtor_pan
string, optional
The debtor’s PAN
creditor_pan
string
The creditor’s PAN
currency_code
string
The currency of the payment. Defaults to USD.
debtor_pan
string, optional
The debtor’s PAN
creditor_pan
string
The creditor’s PAN
Sample payment attributes
{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_pan": "1111222233334444",
"creditor_pan": "4444333322221111"
}{
"end_to_end_id": "#123123123",
"reference": "p:474747474747474747",
"customer_last_logged_at": "2020-09-23T10:57:28Z",
"customer_ip_address": "10.0.0.1",
"customer_ip_port": "3456",
"customer_device_os": "iOS 11",
"customer_user_agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36",
"customer_latitude": "51.5074",
"customer_longitude": "0.1278",
"debtor_name": "Lucas Hahn",
"debtor_address": "Fehrbelliner Str. 95, 10119 Berlin, Germany",
"debtor_street_name": "Fehrbelliner Str.",
"debtor_building_number": "95",
"debtor_post_code": "10119",
"debtor_town": "Berlin",
"debtor_region": "Germany",
"debtor_country_code": "DE",
"creditor_name": "Jay Dawson",
"creditor_agent": "123456",
"creditor_agent_name": "Treasury Devision",
"creditor_address": "Level 39, One Canada Square, Canary Wharf, London E14 5AB, UK",
"creditor_street_name": "One Canada Square",
"creditor_building_number": "One",
"creditor_post_code": "E14 5AB",
"creditor_town": "London",
"creditor_region": "England",
"creditor_country_code": "UK",
"amount": "199000.00",
"currency_code": "EUR",
"description": "Stocks purchase",
"purpose_code": "3456",
"date": "2020-09-23",
"time": "10:20:30",
"debtor_pan": "1111222233334444",
"creditor_pan": "4444333322221111"
}