{"openapi":"3.0.0","externalDocs":{"description":"Documentation","url":"https://docs.saltedge.com/payment_initiation/v1"},"info":{"version":"1.0.0","title":"Salt Edge Payment Initiation API","description":"API Reference for services","contact":{"name":"Support Team","email":"support@saltedge.com","url":"https://www.saltedge.com/pages/contact"}},"servers":[{"url":"https://www.saltedge.com/api/payments/v1"}],"security":[{"app_id":[],"secret":[]}],"paths":{"/customers":{"post":{"summary":"Creates a customer.","description":"Creates a customer, returning the customer object.","tags":["Customers"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedCustomerResponse"},"example":{"data":{"id":"222222222222222222","identifier":"12rv1212f1efxchsdhbgv","secret":"AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8","created_at":"2020-03-12T09:20:01Z","updated_at":"2020-03-12T09:20:01Z"}}}}},"409":{"description":"A customer with such an `identifier` already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"Either an `identifier` is missing from the request body or is not an integer/string","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerRequestBody"}}}}},"get":{"summary":"All customers.","description":"List all of your app's customers.\nThis route is available only for web applications, not mobile ones.\n","tags":["Customers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomersResponse"},"example":{"data":[{"id":"222222222222222222","identifier":"unique_customer_identifier","secret":"AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8","created_at":"2020-03-12T09:20:01Z","updated_at":"2020-03-12T09:20:01Z"},{"id":"222222222222222223","identifier":"unique_customer_identifier_2","secret":"Ct124tk12j0129i10-1j2k124kgk1lgqvUJ8CIC80-8","created_at":"2020-03-12T09:20:01Z","updated_at":"2020-03-12T09:20:01Z"}],"meta":{"next_id":"222222222222222224","next_page":"/api/payments/v1/customers?from_id=222222222222222224"}}}}}},"parameters":[{"in":"query","name":"identifier","required":false,"schema":{"type":"string","description":"A unique identifier of a customer"}}]}},"/customers/{customer_id}/lock":{"put":{"summary":"Lock customer","description":"Locks a customer and its data, returning the customer object.\n\n\nAll customer related data, including payments, will not be available for reading, updating or deleting even by Salt Edge.\nThis route is available only for web applications.\n","tags":["Customers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockedCustomerResponse"},"example":{"data":{"locked":true,"id":"222222222222222222"}}}}},"404":{"description":"Customer with the passed `customer_id` could not be located","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"integer","description":"the `id` of the customer"}}]}},"/customers/{customer_id}/unlock":{"put":{"summary":"Unlock customer","description":"Unlocks a customer and its data, returning the customer object.\nThis route is available only for web applications.\n","tags":["Customers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockedCustomerResponse"},"example":{"data":{"unlocked":true,"id":"222222222222222222"}}}}},"404":{"description":"Customer with the passed `customer_id` could not be located","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"integer","description":"the `id` of the customer"}}]}},"/customers/{customer_id}":{"get":{"summary":"Show customer","description":"Returns the customer object.\n","tags":["Customers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerResponse"},"example":{"data":{"id":"222222222222222222","identifier":"12rv1212f1efxchsdhbgv","secret":"AtQX6Q8vRyMrPjUVtW7J_O1n06qYQ25bvUJ8CIC80-8","created_at":"2020-03-12T09:20:01Z","updated_at":"2020-03-12T09:20:01Z"}}}}},"404":{"description":"Customer with such a `customer_id` could not be located","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"integer","description":"the `id` of the customer"}}]},"delete":{"summary":"Remove a customer","description":"Deletes a customer, returning the customer object.\nThis route is available only for web applications.\n","tags":["Customers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovedCustomerResponse"},"example":{"data":{"deleted":true,"id":"222222222222222222"}}}}},"404":{"description":"Customer with the passed `customer_id` could not be located","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"Current customer is locked. It can be [unlocked](#customers-unlock)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"integer","description":"the `id` of the customer"}}]}},"/payments/connect":{"post":{"summary":"Pay with Connect","description":"The easiest way to initiate payments using Salt Edge API is to use Salt Edge Connect, which handles all the authentication interaction with the user.\nAfter you will 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.\n","tags":["Pay With Connect"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenResponse"},"example":{"data":{"expires_at":"2026-07-07T14:11:51Z","connect_url":"https://www.saltedge.com/payments/connect?token=GENERATED_TOKEN"}}}}},"406":{"description":"At least one of current eIDAS certificates does not have the `PSP_PI` role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"Current client does not have QWAC and QSEAL certificates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenRequestBody"}}}}}},"/payments":{"post":{"summary":"Create payment","description":"The credentials object should be modeled after the provider's fields.","tags":["Pay With Direct Api"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedPaymentResponse"},"example":{"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":"255.255.255.255","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"}]}}}}},"406":{"description":"The selected provider is `disabled`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"Either `payment_attributes`, `template_identifier`, `provider_code`, `credentials` and/or `customer_id` are missing from the request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequestBody"}}}}},"get":{"summary":"List of payments","description":"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](/general/v5/#pagination) section of the reference.\n","tags":["Payments"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsList"},"example":{"data":[{"id":"131313131313131313","provider_code":"fake_client_xf","provider_name":"Fake Bank with Client Keys","customer_id":"222222222222222222","created_at":"2026-06-22T13:11:51Z","updated_at":"2026-07-05T13:11:51Z","status":"processing","template_identifier":"SEPA","payment_attributes":{"end_to_end_id":"#123123123","reference":"p:474747474747474747","customer_last_logged_at":"2026-07-05T13:11:51Z","customer_ip_address":"255.255.255.255","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":"2026-07-05T13:11:51Z"},{"id":"242424242424242421","name":"start","created_at":"2026-07-05T13:11:51Z"},{"id":"242424242424242422","name":"interactive","created_at":"2026-07-05T13:11:51Z","interactive_html":"\u003cdiv id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='iban'\u003e\u003cspan\u003eChoose and input account iban:\u003c/span\u003e\u003col\u003e\u003cli value='XF123456789012345678'\u003eXF123456789012345678 (800.0 EUR)\u003c/li\u003e\u003cli value='XF876543210987654321'\u003eXF876543210987654321 (800.0 USD)\u003c/li\u003e\u003c/ol\u003e\u003c/div\u003e","interactive_fields_names":["iban"]}]}],"meta":{"next_id":"131313131313131314","next_page":"/api/payments/v1/payments?customer_id=5122311\u0026from_id=131313131313131314"}}}}},"400":{"description":"Either `next_id`, `from_id` and/or `customer_id` exceed integer limit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"query","name":"from_id","required":false,"schema":{"type":"string","nullable":true,"description":"the `id` of the record starting the next page."}},{"in":"query","name":"customer_id","required":true,"schema":{"type":"string","description":"the `id` of the customer containing the payments"}}]}},"/payments/oauth":{"post":{"summary":"OAuth","description":"OAuth","tags":["Pay With Direct Api"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OauthPaymentResponse"},"example":{"data":{"payment_id":"131313131313131313","expires_at":"2026-07-07T14:11:51Z","redirect_url":"https://www.saltedge.com/api/payments/v1/payments/redirect?token=GENERATED_TOKEN"}}}}},"406":{"description":"If `return_to` is not specified or is passed an invalid one","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"Either `provider_code`, `customer_id`, `payment_attributes` and/or `template_identifier` are missing from the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OauthPaymentRequestBody"}}}}}},"/payments/authorize":{"put":{"summary":"Authorize OAuth payment","description":"Authorize OAuth payment","tags":["Pay With Direct Api"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedPaymentResponse"},"example":{"data":{"id":"131313131313131313","provider_code":"fake_oauth_client_xf","provider_name":"Fake OAuth Bank with Client Keys","customer_id":"222222222222222222","created_at":"2020-07-23T08:02:57Z","updated_at":"2020-07-23T08:02:57Z","status":"processing","template_identifier":"SEPA","payment_attributes":{"end_to_end_id":"#123123123","reference":"p:474747474747474747","customer_last_logged_at":"2020-07-21T13:48:40Z","customer_ip_address":"255.255.255.255","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-23T08:02:57Z"}]}}}}},"400":{"description":"Either `query_string` and/or `payment_id` are missing from the request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"Some critical information is missing from the request (e.g. a specific field in certificate)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The`payment_id` has not been correctly provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizePaymentRequestBody"}}}}}},"/payments/{payment_id}/confirm":{"put":{"summary":"Confirm payment","description":"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.","tags":["Pay With Direct Api"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedPaymentResponse"},"example":{"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":"255.255.255.255","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":" \u003cdiv id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'\u003e\u003cspan\u003ePlease authorize payment for total of 100.35 EUR.\u003c/span\u003e\u003col\u003e  \u003cli value=''\u003ePayment fee.: 0.1 EUR\u003c/li\u003e\u003cli value=''\u003eBank fee.: 0.25 EUR\u003c/li\u003e\u003c/ol\u003e\u003c/div\u003e","interactive_fields_names":["confirmation_code"],"interactive_fields_options":null},{"name":"submission","created_at":"2020-07-27T10:38:23Z","interactive_fields":{"iban":"XF123456789012345678"}}]}}}}},"400":{"description":"Interactive fields key is missing from the request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"The payment is finished i.e. `last_stage=finish`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The`payment_id` has been provided incorrectly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"payment_id","required":true,"schema":{"type":"string","description":"the `id` of the payment"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteractivePaymentRequestBody"}}}}}},"/payments/{payment_id}/cancel":{"put":{"summary":"Cancel payment","description":"Allows you to cancel the payment initiation. Note: payment can be canceled only being in `initialize` stage.","tags":["Pay With Direct Api"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedPaymentResponse"},"example":{"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":"255.255.255.255","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":" \u003cdiv id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'\u003e\u003cspan\u003ePlease authorize payment for total of 100.35 EUR.\u003c/span\u003e\u003col\u003e  \u003cli value=''\u003ePayment fee.: 0.1 EUR\u003c/li\u003e\u003cli value=''\u003eBank fee.: 0.25 EUR\u003c/li\u003e\u003c/ol\u003e\u003c/div\u003e","interactive_fields_names":["confirmation_code"],"interactive_fields_options":null},{"name":"finish","created_at":"2020-07-27T12:19:33Z"}]}}}}},"404":{"description":"The`payment_id` is provided incorrectly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"payment_id","required":true,"schema":{"type":"string","description":"the `id` of the payment"}}]}},"/payments/{payment_id}":{"get":{"summary":"Show payment","description":"Returns a single payment object.","tags":["Payments"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SinglePayment"},"example":{"data":{"id":"131313131313131313","provider_code":"fake_client_xf","provider_name":"Fake Bank with Client Keys","customer_id":"222222222222222222","created_at":"2026-07-07T12:46:51Z","updated_at":"2026-07-07T12:52:51Z","status":"accepted","template_identifier":"SEPA","payment_attributes":{"end_to_end_id":"#123123123","reference":"p:474747474747474747","customer_last_logged_at":"2026-07-05T13:11:51Z","customer_ip_address":"255.255.255.255","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":"2026-07-07T12:46:51Z"},{"id":"242424242424242421","name":"start","created_at":"2026-07-07T12:47:51Z"},{"id":"242424242424242422","name":"submission","created_at":"2026-07-07T12:48:51Z"},{"id":"242424242424242423","name":"interactive","created_at":"2026-07-07T12:49:51Z","interactive_html":"\u003cdiv id='saltedge-interactive' data-saltedge-type='radio' data-saltedge-name='type_index'\u003e\u003cspan\u003ePlease authorize payment for total of 100.35 EUR.\u003c/span\u003e\u003col\u003e \u003cli value=''\u003ePayment fee.: 0.1 EUR\u003c/li\u003e\u003cli value=''\u003eBank fee.: 0.25 EUR\u003c/li\u003e\u003c/ol\u003e\u003c/div\u003e","interactive_fields_names":["confirmation_code"],"interactive_fields_options":null},{"id":"242424242424242424","name":"submission","created_at":"2026-07-07T12:49:51Z","interactive_fields":{"iban":"XF123456789012345678","confirmation_code":123456}},{"id":"242424242424242425","name":"settlement","created_at":"2026-07-07T12:50:51Z"},{"id":"242424242424242426","name":"completed","created_at":"2026-07-07T12:51:51Z"},{"id":"242424242424242427","name":"finish","created_at":"2026-07-07T12:52:51Z"}]}}}}},"404":{"description":"The`payment_id` could not be located","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"payment_id","required":true,"schema":{"type":"string","description":"the `id` of the payment"}}]},"delete":{"summary":"Remove payment","description":"Removes a payment from our system.\nIt is possible to remove only finished payments, failed or succeeded.\n","tags":["Payments"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovedPayment"},"example":{"data":{"id":"131313131313131313","removed":true}}}}},"404":{"description":"The `payment_id` has not been correctly provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"There was an attempt to remove a payment before it is finished i.e. its `last_stage` is not `finished`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"payment_id","required":true,"schema":{"type":"string","description":"the `id` of the payment"}}]}},"/payments/{payment_id}/refresh":{"put":{"summary":"Refresh payment status","description":"Allows you to trigger a refresh of the payment status.","tags":["Payments"],"responses":{"200":{"description":"Payment status has not yet changed on the bank side. The status can be `unknown` until we get an updated status from the bank (either `rejected` or `accepted`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The `payment_id` is provided incorrectly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"The payment is already processing i.e. `last_stage != finish`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"payment_id","required":true,"schema":{"type":"string","description":"the `id` of the payment"}}]}},"/providers":{"get":{"summary":"List of providers","description":"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.\nProviders that require a client provider key will be included only if you have created provider keys for them.\n","tags":["Providers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvidersResponse"},"example":{"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":"2026-06-27T13:11:51Z","updated_at":"2026-07-02T13:11:51Z","payment_templates":["SEPA"],"supported_payment_fields":{"SEPA":["amount","creditor_iban","creditor_name","currency_code","customer_ip_address","description","end_to_end_id"]},"required_payment_fields":{"SEPA":["amount","creditor_iban","creditor_name","currency_code","customer_ip_address","description","end_to_end_id"]}}],"meta":{"next_id":null,"next_page":null}}}}},"400":{"description":"The `from_date` does not fit the admissible date range","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"query","name":"from_id","required":false,"schema":{"type":"string","nullable":true,"description":"the `id` of the record starting the next page."}},{"in":"query","name":"from_date","required":false,"schema":{"type":"string","nullable":true,"format":"date","description":"filtering providers by the `updated_at` attribute, starting from this date."}},{"in":"query","name":"country_code","required":false,"schema":{"type":"string","nullable":true,"description":"filtering providers by `country`."}},{"in":"query","name":"mode","required":false,"schema":{"type":"string","nullable":true,"enum":["oauth","api"],"description":"Filtering providers by `mode`."}},{"in":"query","name":"include_fake_providers","required":false,"schema":{"type":"boolean","description":"whether you wish to fetch the fake providers."}},{"in":"query","name":"template_identifier","required":false,"schema":{"type":"string","nullable":true,"description":"return only providers that support the given payment template."}},{"in":"query","name":"include_provider_fields","required":false,"schema":{"type":"boolean","description":"whether you wish to include all provider fields in the provider objects."}},{"in":"query","name":"provider_key_owner","required":false,"schema":{"type":"string","nullable":true,"enum":["client","saltedge"],"description":"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](/payment_initiation/v1/#client_provider_keys).\n"}}]}},"/providers/{provider_code}":{"get":{"summary":"Show provider","description":"Allows you to inspect a single provider in order to give your users a proper interface to input their credentials.\nThe response will have an array of `required_fields` and `interactive_fields`.\n","tags":["Providers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderResponse"},"example":{"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":"2026-06-27T13:11:51Z","updated_at":"2026-07-02T13:11:51Z","payment_templates":["SEPA"],"supported_payment_fields":{"SEPA":["amount","creditor_iban","creditor_name","currency_code","customer_ip_address","description","end_to_end_id"]},"required_payment_fields":{"SEPA":["amount","creditor_iban","creditor_name","currency_code","customer_ip_address","description","end_to_end_id"]}}}}}},"404":{"description":"The `provider_code` does not match any known provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"provider_code","required":true,"schema":{"type":"string","description":"the code of the provider"}}]}},"/templates/{template_identifier}":{"get":{"summary":"Show template","description":"Returns a single payment template object.","tags":["Templates"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateResponse"},"example":{"data":{"id":"131313131313131313","identifier":"SEPA","description":"SEPA Payment","deprecated":false,"created_at":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z","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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z","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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z","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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"}]}}}}},"404":{"description":"No payment template was found by the passed template `identifier`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"in":"path","name":"template_identifier","required":true,"schema":{"type":"string","description":"the requested template identifier"}}]}},"/templates":{"get":{"summary":"List of templates","description":"Returns all the available payment templates.","tags":["Templates"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatesResponse"},"example":{"data":{"id":"131313131313131313","identifier":"SEPA","description":"SEPA Payment","deprecated":false,"created_at":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z","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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z","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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z","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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"},{"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":"2026-07-04T13:11:51Z","updated_at":"2026-07-04T13:11:51Z"}]}}}}}},"parameters":[{"in":"query","name":"from_id","required":false,"schema":{"type":"string","nullable":true,"description":"the `id` of the record starting the next page."}},{"in":"query","name":"deprecated","required":false,"schema":{"type":"boolean","description":"filtering payment templates by deprecation. All the supported payment templates will be returned if no value was set."}}]}}},"components":{"securitySchemes":{"app_id":{"type":"apiKey","name":"App-id","in":"header"},"secret":{"type":"apiKey","name":"Secret","in":"header"}},"schemas":{"Customer":{"type":"object","description":"A customer represents a person who will be using your application.\nYou need to store the `id` returned from the response in your application, which is necessary when creating payments.\n","required":["id","identifier","secret","created_at","updated_at"],"properties":{"id":{"type":"integer","description":"Creates a customer, returning the customer object."},"identifier":{"type":"string","description":"A unique identifier of the new customer"},"secret":{"type":"string","description":"Customer secret."},"created_at":{"type":"string","format":"date-time","description":"when the customer was created"},"updated_at":{"type":"string","format":"date-time","description":"when the customer was updated"}}},"CustomerRequestBody":{"type":"object","description":"Customer object.","required":["data"],"properties":{"data":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"A unique identifier of the new customer"}}}}},"CustomerResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"}}},"CreatedCustomerResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"}}},"LockedCustomerResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"locked":{"type":"boolean","default":true},"id":{"type":"integer"}}}}},"UnlockedCustomerResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"unlocked":{"type":"boolean","default":true},"id":{"type":"integer"}}}}},"RemovedCustomerResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"deleted":{"type":"boolean","default":true},"id":{"type":"integer"}}}}},"CustomersResponse":{"type":"object","description":"A list of all customers.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"meta":{"$ref":"#/components/schemas/MetaObject"}}},"MetaObject":{"type":"object","description":"Metaobject that contains information about pagination.","properties":{"next_id":{"type":"string"},"next_page":{"type":"string"}}},"PaymentTokenRequestBody":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["customer_id","payment_attributes","template_identifier"],"properties":{"customer_id":{"type":"string","description":"the `id` of the customer received from [customer create](#customers-create)"},"provider_code":{"type":"string","description":"the code of the desired provider. To access the list of providers that support payments, see [providers list](#providers-list). If passed, make sure the chosen provider supports the desired payment template.\n\nEven though the `provider_code` is an `optional` field, its absence during payment initiation may lead to the following outcomes:\n\n - The end-user may choose a provider that does not support the payment template the client has passed to Salt Edge. This will result in an error.\n - The end-user may choose a provider that has additional `required_payment_fields`. Absence of required payment attributes during payment initiation will result in an error.\n"},"payment_attributes":{"$ref":"#/components/schemas/PaymentAttributes"},"template_identifier":{"type":"string","description":"the payment template identifier received in [show templates](#payment_templates-show)"},"return_to":{"type":"string","description":"the URL the user will be redirected to. Defaults to the `client's home URL`"},"show_consent_confirmation":{"type":"boolean","default":true,"description":"if sent as `false`, upon submitting the form, the end-user will not be asked to give consent to Salt Edge."},"disable_provider_search":{"type":"boolean","description":"if sent as `true`, together with `provider_code`, does not allow the end-user to change the preselected provider."},"javascript_callback_type":{"type":"string","nullable":true,"enum":["post_message"],"description":"allows you to specify what kind of callback type you are expecting."},"return_payment_id":{"type":"boolean","description":"whether to append `payment_id` to `return_to` URL."},"return_error_class":{"type":"boolean","description":"whether to append `error_class` to `return_to` URL."},"locale":{"type":"string","description":"the language of the Payments Connect widget and of the returned error message(s) in the \u003ca href='http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes' target=\"_blank\"\u003eISO 639-1\u003c/a\u003e format. Possible values are: `bg`, `cz`, `de`, `en`, `es-MX`, `es`, `fi`, `fr`, `he`, `hr`, `hu`, `it`, `nl`, `pl`, `pt-BR`, `pt`, `ro`, `ru`, `si`, `sk`, `sv`, `tr`, `uk`, `zh-HK`(Traditional), `zh`(Simplified). Defaults to `en`."},"country_code":{"type":"string","nullable":true,"description":"returns the list of providers only from given country. Possible values: any country code from \u003ca href='http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2' target=\"_blank\"\u003eISO 3166-1 alpha-2\u003c/a\u003e, e.g.: `'DE'`."},"custom_fields":{"type":"object","description":"a JSON object, which will be sent back on any of your callbacks"}}}}},"PaymentTokenResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"expires_at":{"type":"string","format":"date-time"},"connect_url":{"type":"string"}}}}},"PaymentRequestBody":{"type":"object","description":"The credentials object should be modeled after the provider's fields.","required":["data"],"properties":{"data":{"type":"object","required":["customer_id","provider_code","credentials","payment_attributes","template_identifier"],"properties":{"customer_id":{"type":"string","description":"the `id` of the customer received from [customer create](#customers-create)"},"provider_code":{"type":"string","description":"the code of the desired provider. To access the list of providers that support payments, see [providers list](#providers-list).\n\nEven though the `provider_code` is an `optional` field, its absence during payment initiation may lead to the following outcomes:\n\n - The end-user may choose a provider that does not support the payment template the client has passed to Salt Edge. This will result in an error.\n - The end-user may choose a provider that has additional `required_payment_fields`. Absence of required payment attributes during payment initiation will result in an error.\n"},"credentials":{"type":"object","description":"the credentials required to initiate a payment"},"payment_attributes":{"$ref":"#/components/schemas/PaymentAttributes"},"template_identifier":{"type":"string","description":"payment template identifier received in [show templates](#payment_templates-show)"},"custom_fields":{"type":"object","description":"a JSON object, which will be sent back on any of your callbacks"},"locale":{"type":"string","description":"the language of the error message in the \u003ca href='http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes' target=\"_blank\"\u003eISO 639-1\u003c/a\u003e format. Possible values are: `bg`, `cz`, `de`, `en`, `es-MX`, `es`, `fi`, `fr`, `he`, `hr`, `hu`, `it`, `nl`, `pl`, `pt-BR`, `pt`, `ro`, `ru`, `si`, `sk`, `sv`, `tr`, `uk`, `zh-HK`(Traditional), `zh`(Simplified). Defaults to `en`."}}}}},"OauthPaymentRequestBody":{"type":"object","description":"The credentials object should be modeled after the provider's fields.","required":["data"],"properties":{"data":{"type":"object","required":["customer_id","provider_code","payment_attributes","template_identifier","return_to"],"properties":{"customer_id":{"type":"string","description":"the `id` of the customer received from [customer create](#customers-create)"},"provider_code":{"type":"string","description":"the code of the desired provider. To access the list of providers that support payments, see [providers list](#providers-list).\n\nEven though the `provider_code` is an `optional` field, its absence during payment initiation may lead to the following outcomes:\n\n - The end-user may choose a provider that does not support the payment template the client has passed to Salt Edge. This will result in an error.\n - The end-user may choose a provider that has additional `required_payment_fields`. Absence of required payment attributes during payment initiation will result in an error.\n"},"payment_attributes":{"$ref":"#/components/schemas/PaymentAttributes"},"template_identifier":{"type":"string","description":"payment template identifier received in [show templates](#payment_templates-show)"},"return_to":{"type":"string","description":"the URL the user will be redirected to after authenticating 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](#payments-authorize) in order to authorize the payment.\n"},"locale":{"type":"string","description":"the language of the error message in the \u003ca href='http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes' target=\"_blank\"\u003eISO 639-1\u003c/a\u003e format. Possible values are: `bg`, `cz`, `de`, `en`, `es-MX`, `es`, `fi`, `fr`, `he`, `hr`, `hu`, `it`, `nl`, `pl`, `pt-BR`, `pt`, `ro`, `ru`, `si`, `sk`, `sv`, `tr`, `uk`, `zh-HK`(Traditional), `zh`(Simplified). Defaults to `en`."},"custom_fields":{"type":"object","description":"a JSON object, which will be sent back on any of your callbacks"}}}}},"AuthorizePaymentRequestBody":{"type":"object","properties":{"data":{"type":"object","required":["payment_id","query_string"],"properties":{"payment_id":{"type":"string","description":"the `id` of the payment that is being authorized"},"query_string":{"type":"string","description":"all the parameters appended to your `return_to` URL upon being redirected from the provider back to your application"}}}}},"OauthPaymentResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"payment_id":{"type":"string","description":"Payment ID"},"expires_at":{"type":"string","format":"date-time","description":"Expires at"},"redirect_url":{"type":"string","description":"Redirect URL"}}}}},"CreatedPaymentResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"provider_code":{"type":"string"},"provider_name":{"type":"string"},"customer_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"status":{"type":"string"},"template_identifier":{"type":"string"},"payment_attributes":{"$ref":"#/components/schemas/PaymentAttributes"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}},"custom_fields":{"type":"object"}}}}},"InteractivePaymentRequestBody":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["interactive_fields"],"properties":{"interactive_fields":{"type":"object","description":"The credentials object based on the provider’s interactive fields"}}}}},"Payment":{"type":"object","description":"The payment resource represents a detailed description of a particular payment. They are meant to provide you with more information about the executed payments for further usage in technical and statistical purposes.\n","required":["id","payment_attributes","template_identifier","status","stages","created_at","updated_at","custom_fields"],"properties":{"id":{"type":"string","description":"the `id` of the payment"},"payment_attributes":{"$ref":"#/components/schemas/PaymentAttributes"},"template_identifier":{"type":"string","description":"the `identifier` of the [payment template](#payment_templates) used for this payment"},"status":{"type":"string","description":"possible values are:\n\n  - `processing` -- the payment order execution is in progress, more detailed information about its status can be found in the current `stage`. Possible `stages` -  [all](#payments-stages) except for `finish`.\n  - `accepted` -- the payment order was accepted by the provider. Possible `stages`- `finish`.\n  - `rejected` -- the payment order was rejected by the provider, and a reason is provided. Possible `stages` - `finish`.\n  - `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. Possible `stages` - `finish`.\n  - `unknown` -- the payment order could not be confirmed to be either successful or `failed`/`rejected` within the allocated time. Possible `stages` - `finish`.\n  - `deleted` -- the payment was deleted. Possible `stages`- `finish`.\n"},"stages":{"type":"array","description":"Information about [stages](#payments-stages) through which the payment has passed","items":{"$ref":"#/components/schemas/Stage"}},"created_at":{"type":"string","format":"date-time","description":"time and date when the payment was made"},"updated_at":{"type":"string","format":"date-time","description":"the last time when any of the payment's attributes were changed"},"custom_fields":{"type":"object","description":"a JSON object, which will be sent back on any of your callbacks"}}},"Stage":{"type":"object","description":"The following represents the objects you get in the `stages` field of the payment object.","required":["id","name","created_at"],"properties":{"id":{"type":"string","description":"the `id` of the stage"},"name":{"type":"string","description":"the name of the stage. Possible values:\n\n  - `initialize` - the payment object was created\n  - `start` - the payment process has just begun\n  - `interactive` - waiting for the interactive input\n  - `submission` - preparing a payment initiation request for submission to the financial institution\n  - `settlement` - payment initiation request accepted by the financial institution, waiting for settlement to complete\n  - `completed` - payment initiation settlement has been completed, funds have been sent\n  - `finish` - wrapping up the payment process.\n"},"interactive_html":{"type":"string","description":"HTML code that shows the current interactive state of the payment. Appears only for the interactive providers.\n"},"interactive_fields_names":{"type":"array","description":"the interactive fields that are currently required by the provider of the payment. Appears only for the interactive providers.\n","items":{"type":"string"}},"error_class":{"type":"string","description":"error class name. Appears only when an error occurs."},"message":{"type":"string","description":"brief error description. Appears only when an error occurs."},"created_at":{"type":"string","format":"date-time","description":"time and date when the stage was created"}}},"SinglePayment":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Payment"}}},"PaymentsList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"meta":{"$ref":"#/components/schemas/MetaObject"}}},"RemovedPayment":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","removed"],"properties":{"id":{"type":"string","description":"ID of removed payment."},"removed":{"type":"boolean","default":true}}}}},"Provider":{"type":"object","description":"A provider is a Financial Institution which can execute payments.\nWe recommend you update all of the providers' fields at least daily.\n\nThe [map](https://www.saltedge.com/products/spectre/countries?channel%5B%5D=open_banking) 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.\n","required":["id","code","name","mode","status","interactive","instruction","home_url","forum_url","logo_url","country_code","created_at","updated_at","payment_templates","identification_codes","bic_codes","supported_iframe_embedding"],"properties":{"id":{"type":"integer","description":"the `id` of the provider"},"code":{"type":"string","description":"the provider's code"},"name":{"type":"string","description":"the provider's name"},"mode":{"type":"string","enum":["oauth","api"],"description":"the provider's mode."},"status":{"type":"string","description":"possible values: `active`, `inactive`, `disabled`\n\n- The providers with the `inactive` status are returned on the [providers list](#providers-list) endpoint, but are not visible on the Connect widget for the end-users.\n- The providers with `disabled` status are neither returned on the [providers list](#providers-list) endpoint, nor visible on the Connect widget for end-users.\n"},"interactive":{"type":"boolean","description":"Whether the provider requires interactive input"},"instruction":{"type":"string","description":"guidance on how to connect the provider"},"home_url":{"type":"string","description":"the URL of the main page of the provider"},"forum_url":{"type":"string","description":"the URL for the [Salt Edge Support](https://www.saltedge.com/support_requests/new) page, dedicated to the provider"},"logo_url":{"type":"string","description":"the URL for the provider logo. May have a placeholder for providers with missing logos.\n"},"country_code":{"type":"string","description":"Code of the provider's `country`"},"created_at":{"type":"string","format":"date-time","description":"time and date when the provider was integrated"},"updated_at":{"type":"string","format":"date-time","description":"the last time when any of the provider’s attributes were changed"},"payment_templates":{"type":"array","description":"identifiers of the [payment templates](#payment_templates) that are supported by this provider","items":{"type":"string"}},"identification_codes":{"type":"array","description":"list of codes identifying supported branches of a specific provider. It may include BLZ(Germany), ABI+CAB(Italy), Branch Codes(France) etc.","items":{"type":"string"}},"bic_codes":{"type":"array","description":"list of BIC codes identifying supported branches of a specific provider.","items":{"type":"string"}},"supported_iframe_embedding":{"type":"boolean","enum":[true,false],"description":"Provider can be embedded in `iframe`."},"supported_payment_fields":{"type":"object","description":"if these fields are passed, they will be used by the provider. Otherwise, the payment will we processed even without them."},"required_payment_fields":{"type":"object","description":"mandatory payment attributes. If any of these fields are not passed, the payment will not be initiated successfully."},"no_funds_rejection_supported":{"type":"boolean","description":"A flag which indicates whether the bank supports explicit handling of payment rejection due to insufficient funds.\n\nFor example, it can be a header in the request (`TPP-Rejection-NoFunds-Preferred`) which set to `true` will automatically reject the payment in case of insufficient funds. Note that many banks handle this behaviour by default, but some of them offer the possibility to choose the outcome of insufficient funds.\n"}}},"ProviderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Provider"}}},"ProvidersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Provider"}},"meta":{"$ref":"#/components/schemas/MetaObject"}}},"Template":{"type":"object","description":"The 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.\n","required":["id","identifier","description","deprecated","payment_fields","created_at","updated_at"],"properties":{"id":{"type":"string","description":"the `id` of the payment template"},"identifier":{"type":"string","description":"unique identifier of the payment template"},"description":{"type":"string","description":"additional information related to the template"},"deprecated":{"type":"boolean","description":"whether the payment template is deprecated or not. Deprecated payment templates will be removed in the next API version."},"payment_fields":{"type":"array","description":"[payment field objects](#payment_templates-fields)","items":{"$ref":"#/components/schemas/TemplatePaymentField"}},"created_at":{"type":"string","format":"date-time","description":"time and date when the payment template was added"},"updated_at":{"type":"string","format":"date-time","description":"the last time when any of the template’s attributes were changed"}}},"TemplateResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Template"}}},"TemplatesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Template"}},"meta":{"$ref":"#/components/schemas/MetaObject"}}},"TemplatePaymentField":{"type":"object","required":["id","payment_template_id","created_at","updated_at"],"properties":{"id":{"type":"string","description":"the `id` of the payment field"},"payment_template_id":{"type":"string","description":"the `id` of the [payment template](#payment_templates)"},"name":{"type":"string","description":"the field’s name that should be used as a key in the credentials object"},"english_name":{"type":"string","description":"the field’s name in US English"},"localized_name":{"type":"string","description":"The field’s name in the provider's main language"},"nature":{"type":"string","enum":["text","password","select","file","number","dynamic_select"],"description":"Nature"},"position":{"type":"integer","description":"the field’s position in the public user interface"},"extra":{"$ref":"#/components/schemas/TemplatePaymentExtraField"},"optional":{"type":"boolean","description":"whether the input for this field is optional or not"},"field_options":{"type":"object","description":"only for the `select` field type. Contains the options for the select."},"created_at":{"type":"string","format":"date-time","description":"time and date when the payment field was added"},"updated_at":{"type":"string","format":"date-time","description":"the last time when any of the payment field’s attributes were changed"}}},"TemplatePaymentExtraField":{"type":"object","description":"The following represents the object you get in the `extra` field of the payment field object.","properties":{"validation_regexp":{"type":"string","description":"the regexp used for the payment field validation"}}},"CommonPaymentAttributes":{"type":"object","required":["end_to_end_id","customer_ip_address","creditor_name","creditor_country_code","amount","description"],"properties":{"end_to_end_id":{"type":"string","description":"An internal identifier used by the merchants and not accesible/visible to the end-user"},"reference":{"type":"string","description":"An external identifier which is visible to the end-user (e.g. tracking number, order number, bill number, etc)"},"customer_last_logged_at":{"type":"string","format":"date-time","description":"Time when the customer was last logged in"},"customer_ip_address":{"type":"string","description":"IP address of the customer"},"customer_ip_port":{"type":"string","description":"IP port of the customer"},"customer_device_os":{"type":"string","description":"The operating system of the customer"},"customer_user_agent":{"type":"string","description":"The user-agent of the customer"},"customer_latitude":{"type":"string","description":"Defines the customer's location"},"customer_longitude":{"type":"string","description":"Defines the customer's location"},"debtor_name":{"type":"string","description":"The full name of the debtor (payer)"},"debtor_address":{"type":"string","description":"The full address of the debtor"},"debtor_street_name":{"type":"string","description":"The street name of the debtor"},"debtor_building_number":{"type":"string","description":"The building number of the debtor"},"debtor_post_code":{"type":"string","description":"The post code of the debtor"},"debtor_town":{"type":"string","description":"The name of the town/city of the debtor"},"debtor_region":{"type":"string","description":"The name of the country/region of the debtor"},"debtor_country_code":{"type":"string","description":"The ISO code of the debtor's country"},"creditor_name":{"type":"string","description":"The full name of the creditor (payee)"},"creditor_agent":{"type":"string","description":"The `id` of the creditor's agent"},"creditor_agent_name":{"type":"string","description":"The name of the creditor's agent"},"creditor_address":{"type":"string","description":"The full address of the creditor"},"creditor_street_name":{"type":"string","description":"The street name of the creditor"},"creditor_building_number":{"type":"string","description":"The building number of the creditor"},"creditor_post_code":{"type":"string","description":"The post code of the creditor"},"creditor_town":{"type":"string","description":"The name of the town/city of the creditor"},"creditor_region":{"type":"string","description":"The name of the country/region of the creditor"},"creditor_country_code":{"type":"string","description":"The ISO code of the creditor's country"},"amount":{"type":"string","description":"Payment amount in the specified currency"},"description":{"type":"string","description":"The unstructured description of the payment:\n\n - Most ASPSPs have certain limitations in place when it comes to the formatting of the unstructured payment remittance information (`description`).\n - Using alphanumeric characters along with `., ,, -, /, ?, (, ), +, '` and spaces as well as keeping the length of the description under 1000 characters should be a safe approach for most ASPSPs (RegExp `/[A-Za-z0-9.-,()+'? ]{2,1000}/`).\n - ASPSPs may extend these constraints depending on their core banking system, payment schema and other relevant factors.\n"},"purpose_code":{"type":"string","description":"ISO 18245 purpose code"},"date":{"type":"string","format":"date","description":"The date when to execute the payment. Defaults to the `current date`."},"time":{"type":"string","format":"time","description":"The precise time when to execute the payment. Defaults to the `current time`."}}},"FasterPaymentAttributes":{"allOf":[{"$ref":"#/components/schemas/CommonPaymentAttributes"},{"type":"object","required":["currency_code","creditor_sort_code","creditor_account_number"],"properties":{"currency_code":{"type":"string","default":"GBP","description":"The currency of the payment."},"debtor_sort_code":{"type":"string","description":"The debtor's bank sort code"},"debtor_account_number":{"type":"string","description":"the debtor's bank account number"},"creditor_sort_code":{"type":"string","description":"the creditor's bank sort code"},"creditor_account_number":{"type":"string","description":"the creditor's bank account number"}}}]},"BACSPaymentAttributes":{"allOf":[{"$ref":"#/components/schemas/CommonPaymentAttributes"},{"type":"object","required":["currency_code","creditor_sort_code","creditor_account_number"],"properties":{"currency_code":{"type":"string","default":"GBP","description":"The currency of the payment."},"debtor_sort_code":{"type":"string","description":"The debtor's bank sort code"},"debtor_account_number":{"type":"string","description":"The debtor's bank account number"},"creditor_sort_code":{"type":"string","description":"The creditor's bank sort code"},"creditor_account_number":{"type":"string","description":"The creditor's bank account number"}}}]},"CHAPSPaymentAttributes":{"allOf":[{"$ref":"#/components/schemas/CommonPaymentAttributes"},{"type":"object","required":["currency_code","creditor_sort_code","creditor_account_number"],"properties":{"currency_code":{"type":"string","default":"GBP","description":"The currency of the payment."},"debtor_sort_code":{"type":"string","description":"The debtor's bank sort code"},"debtor_account_number":{"type":"string","description":"The debtor's bank account number"},"creditor_sort_code":{"type":"string","description":"The creditor's bank sort code"},"creditor_account_number":{"type":"string","description":"The creditor's bank account number"}}}]},"SEPAPaymentAttributes":{"allOf":[{"$ref":"#/components/schemas/CommonPaymentAttributes"},{"type":"object","required":["currency_code","creditor_iban","charge_bearer"],"properties":{"currency_code":{"type":"string","default":"EUR","description":"The currency of the payment."},"debtor_iban":{"type":"string","description":"The debtor's IBAN"},"creditor_iban":{"type":"string","description":"The creditor's IBAN"},"mode":{"type":"string","default":"NORMAL","enum":["NORMAL","INSTANT"],"description":"\u003cspan class=\"note\"\u003e\n  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](#payment_templates-sepa_instant).\n\u003c/span\u003e\n"},"charge_bearer":{"type":"string","default":"SHARED","enum":["CREDITOR","DEBTOR","SHARED"]}}}]},"SEPAInstantPaymentAttributes":{"allOf":[{"$ref":"#/components/schemas/CommonPaymentAttributes"},{"type":"object","required":["currency_code","creditor_iban"],"properties":{"currency_code":{"type":"string","default":"EUR","description":"The currency of the payment."},"debtor_iban":{"type":"string","description":"The debtor's IBAN"},"creditor_iban":{"type":"string","description":"The creditor's IBAN"}}}]},"DOMESTICPaymentAttributes":{"allOf":[{"$ref":"#/components/schemas/CommonPaymentAttributes"},{"type":"object","required":["currency_code"],"properties":{"currency_code":{"type":"string","description":"The currency of the payment."},"debtor_iban":{"type":"string","description":"The debtor's IBAN"},"creditor_iban":{"type":"string","description":"The creditor's IBAN"},"debtor_bban":{"type":"string","description":"The debtor's BBAN"},"creditor_bban":{"type":"string","description":"The creditor's BBAN"}}}]},"PaymentAttributes":{"oneOf":[{"$ref":"#/components/schemas/BACSPaymentAttributes"},{"$ref":"#/components/schemas/CHAPSPaymentAttributes"},{"$ref":"#/components/schemas/FasterPaymentAttributes"},{"$ref":"#/components/schemas/SEPAPaymentAttributes"},{"$ref":"#/components/schemas/SEPAInstantPaymentAttributes"},{"$ref":"#/components/schemas/DOMESTICPaymentAttributes"}]},"ApiError":{"type":"object","description":"Error","required":["error_class","error_message","request"],"properties":{"error_class":{"type":"string","description":"The class of the error."},"error_message":{"type":"string","description":"A message describing the error."},"request":{"type":"object","description":"the body of the request that caused the error."}}}}}}