### Notify Callback Example Source: https://docs.saltedge.com/v6/api_reference An example of a Notify callback sent to the client's application. This callback provides information about the progress of a connection. ```json { "data": { "connection_id": "111111111111111111", "customer_id": "222222222222222222", "custom_fields": { "key": "value" }, "stage": "start" }, "meta": { "version": "6", "time": "2024-01-24T10:40:47Z" } } ``` -------------------------------- ### Destroy Callback Example Source: https://docs.saltedge.com/v6/api_reference An example of a Destroy callback sent to the client's application when a connection is removed. It includes connection and customer identifiers. ```json { "data": { "connection_id": "111111111111111111", "customer_id": "222222222222222222", "custom_fields": { "key": "value" }, }, "meta": { "version": "6", "time": "2024-01-24T10:40:48Z" } } ``` -------------------------------- ### Provider Changes Callback Example Source: https://docs.saltedge.com/v6/api_reference An example of a callback sent when a provider's status changes. It includes the provider's status and code. ```json { "data": { "provider_status": "inactive", "provider_code": "fake_client_xf" }, "meta": { "version": 5, "time": "2023-09-21T09:49:13.472Z" } } ``` -------------------------------- ### Sample Response for Listing All Payment Templates Source: https://docs.saltedge.com/v6/api_reference Example JSON response when listing all supported payment templates, showing an array of template objects. ```json { "data": [ { "identifier": "BACS", "description": "BACS payment", "payment_fields": [ { "name": "customer_latitude", "english_name": "Customer Latitude", "localized_name": "Customer Latitude", "nature": "number", "position": 7, "extra": { "validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$" }, "optional": true }, { "name": "currency_code", "english_name": "Currency", "localized_name": "Currency", "nature": "select", "position": 38, "extra": { "validation_regexp": "" }, "optional": false, "field_options": [ { "name": "GBP", "english_name": "GBP", "localized_name": "GBP", "option_value": "GBP", "selected": true } ] } ] }, { "identifier": "CHAPS", "description": "CHAPS payment", "payment_fields": [ { "name": "customer_latitude", "english_name": "Customer Latitude", "localized_name": "Customer Latitude", "nature": "number", "position": 7, "extra": { "validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$" }, "optional": true }, { "name": "currency_code", "english_name": "Currency", "localized_name": "Currency", "nature": "select", "position": 38, "extra": { "validation_regexp": "" }, "optional": false, "field_options": [ { "name": "GBP", "english_name": "GBP", "localized_name": "GBP", "option_value": "GBP", "selected": true } ] } ] } ] } ``` -------------------------------- ### Sample Bulk Payment Response (GET) Source: https://docs.saltedge.com/v6/api_reference This is a sample JSON response for a single Bulk Payment object retrieved via the GET request. It includes details like ID, customer ID, provider information, and payment attributes. ```json { "data": { "id": "11111111111111111111", "customer_id": "4444444444444444444", "provider_code": "fake_client_xf", "provider_name": "Fake Bank with Client Keys", "created_at": "2025-04-18T13:46:40Z", "updated_at": "2025-04-18T13:46:40Z", "refresh_interval": 3600, "refresh_timeout": 172800, "status": "initiated", "raw_provider_status": null, "template_identifier": "SEPA", "payment_attributes": { "creditors_attributes": [ { "creditor_iban": "SOME_IBAN12345", "amount": 9.99, "currency_code": "EUR" }, { "creditor_iban": "SOME_IBAN54321", "amount": 1.99, "currency_code": "EUR" } ], "shared_payment_attributes": { "debtor_iban": "SOMEOTHERIBAN23456", "description": "some description about the bulk payment" } }, "extra": null, "last_attempt": { "id": "1111111", "custom_fields": {} } } } ``` -------------------------------- ### Sample Response for Specific Payment Template Source: https://docs.saltedge.com/v6/api_reference Example JSON response when requesting a specific payment template, detailing its fields and properties. ```json { "data": { "identifier": "CHAPS", "description": "CHAPS payment", "payment_fields": [ { "name": "customer_latitude", "english_name": "Customer Latitude", "localized_name": "Customer Latitude", "nature": "number", "position": 7, "extra": { "validation_regexp": "^[-+]?[0-9]*\\.?[0-9]+$" }, "optional": true }, { "name": "currency_code", "english_name": "Currency", "localized_name": "Currency", "nature": "select", "position": 38, "extra": { "validation_regexp": "" }, "optional": false, "field_options": [ { "name": "GBP", "english_name": "GBP", "localized_name": "GBP", "option_value": "GBP", "selected": true } ] } ] } } ``` -------------------------------- ### List Countries API Response Example Source: https://docs.saltedge.com/v6/api_reference An example JSON response when requesting a list of countries from the Salt Edge API. It includes country name, code, and refresh start time. ```json { "data": [ { "name": "United Arab Emirates", "code": "AE", "refresh_start_time": 22 }, { "name": "Armenia", "code": "AM", "refresh_start_time": 22 }, { "name": "Argentina", "code": "AR", "refresh_start_time": 5 }, { "name": "Austria", "code": "AT", "refresh_start_time": 1 }, { "name": "Australia", "code": "AU", "refresh_start_time": 16 }, { "name": "Azerbaijan", "code": "AZ", "refresh_start_time": 22 }, { "name": "Bosnia and Herzegovina", "code": "BA", "refresh_start_time": 1 }, { "name": "Barbados", "code": "BB", "refresh_start_time": 6 }, { "name": "Bangladesh", "code": "BD", "refresh_start_time": 20 }, { "name": "Belgium", "code": "BE", "refresh_start_time": 1 } ], "meta": { "next_id": null, "next_page": null } } ``` -------------------------------- ### Sample Request to List All Supported Payment Templates Source: https://docs.saltedge.com/v6/api_reference This cURL command shows how to fetch a list of all supported Bulk Payment templates available through the API. ```bash 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/v6/bulk_payment_templates ``` -------------------------------- ### Get Transactions with Query Parameters Source: https://docs.saltedge.com/v6/api_reference Use this endpoint to fetch transactions. You can filter by connection ID, account ID, pending status, duplication status, starting from a specific transaction ID, and specify the number of results per page. ```bash 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/v6/transactions?connection_id=111111111111111111&account_id=222222222222222&duplicated=true&pending=false&from_id=111111111111111111&per_page=250 ``` -------------------------------- ### List Providers with Query Parameters Source: https://docs.saltedge.com/v6/api_reference This snippet demonstrates how to make a GET request to list providers, utilizing various query parameters for filtering and customization. Ensure your App-id and Secret are set as environment variables. ```bash 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/v6/providers?include_sandboxes=true&country_code=GB&include_ais_fields=false&include_pis_fields=false&include_credentials_fields=false&exclude_inactive=true&key_owner=saltedge&mode=web&from_id=220&per_page=150 ``` -------------------------------- ### Sample Response for Get Connection Source: https://docs.saltedge.com/v6/api_reference This is a sample JSON response when successfully retrieving connection details. It includes information about the connection's status, provider, and refresh settings. ```json { "data": { "id": "11111111111111", "customer_id": "11111111111111", "customer_identifier": "example_identifier", "provider_code": "fake_oauth_client_xf", "provider_name": "Fake OAuth Bank with Client Keys", "country_code": "XF", "status": "active", "categorization": "personal", "categorization_vendor": "saltedge", "automatic_refresh": false, "store_credentials": true, "next_refresh_possible_at": "2024-01-15T14:10:28Z", "created_at": "2024-01-03T14:58:19Z", "updated_at": "2024-01-15T13:55:28Z", "last_consent_id": "11111111111111", "last_attempt": { "id": "11111111111111", "consent_id": "11111111111111", "api_version": "6", "api_mode": "service", "automatic_fetch": true, "categorize": true, "custom_fields": {}, "automatic_refresh": false, "exclude_accounts": [], "fetch_from_date": "2023-11-16", "fetch_to_date": "2024-01-15", "fetch_scopes": [ "accounts", "balance", "holder_info", "transactions" ], "finished": true, "finished_recent": true, "include_natures": null, "interactive": false, "locale": "ro", "partial": false, "show_consent_confirmation": true, "store_credentials": true, "user_present": true, "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:120.0) Gecko/20100101 Firefox/120.0", "device_type": "desktop", "remote_ip": "10.9.9.9", "customer_last_logged_at": null, "created_at": "2024-01-15T13:55:11Z", "updated_at": "2024-01-15T13:55:28Z", "success_at": "2024-01-15T13:55:28Z", "fail_at": null, "fail_error_class": null, "fail_message": null, "last_stage": { "id": "11111111111111", "name": "finish", "created_at": "2024-01-15T13:55:28Z", "updated_at": "2024-01-15T13:55:28Z" } } } } ``` -------------------------------- ### Import Accounts POST Request Example Source: https://docs.saltedge.com/v6/api_reference This cURL command demonstrates how to send a POST request to the Salt Edge API to import accounts. It includes necessary headers and a JSON payload with account details. ```bash curl -v -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "App-id: $APP_ID" \ -H "Secret: $SECRET" \ -X POST \ -d "{ \ \"data\": { \ \"bucket_id\": \"some_identifier\", \ \"accounts\": [ \ { \ \"id\": \"some_account_identifier\", \ \"country_code\": \"GB\", \ \"currency_code\": \"EUR\", \ \"nature\": \"account\", \ \"provider_code\": \"some_provider_code\", \ \"holder_name\": \"Holder Name\", \ \"extra\": { \ \"some_key\": \"some_value\" \ } \ }, \ { \ \"id\": \"some_account_identifier\", \ \"country_code\": \"AU\", \ \"currency_code\": \"USD\", \ \"nature\": \"account\", \ \"provider_code\": \"some_provider_code\", \ \"holder_name\": \"Holder Name\", \ \"extra\": { \ \"some_key\": \"some_value\" \ } \ } \ ] \ } \ }" \ https://www.saltedge.com/api/v6/categorization/accounts ``` -------------------------------- ### Failure Callback Example Source: https://docs.saltedge.com/v6/api_reference A failure callback is received when information retrieval from a provider fails. This example includes error details such as error class and message, alongside connection and customer IDs. ```json { "data": { "connection_id": "111111111111111111", "customer_id": "222222222222222222", "custom_fields": { "key": "value" }, "error_class": "InvalidCredentials", "error_message": "Invalid credentials." }, "meta": { "version": "6", "time": "2024-01-25T10:40:47.979Z" } } ``` -------------------------------- ### List Customers GET Response Source: https://docs.saltedge.com/v6/api_reference A sample response for the List Customers GET request. It returns an array of customer objects, including their IDs, identifiers, and timestamps, along with pagination metadata. ```json { "data": [ { "customer_id": "1111111111111111111", "identifier": "email@email.com", "categorization_type": null, "blocked_at": null, "created_at": "2021-09-14T15:14:34Z", "updated_at": "2021-09-14T15:14:34Z" }, { "customer_id": "2222222222222222222", "identifier": "some_identifier", "categorization_type": null, "blocked_at": null, "created_at": "2021-09-14T18:04:11Z", "updated_at": "2021-09-14T18:04:11Z" } ], "meta": { "next_id": "3333333333333333333", "next_page": "/api/v6/customers?from_id=3333333333333333333" } } ``` -------------------------------- ### Sample Response for Listing Accounts Source: https://docs.saltedge.com/v6/api_reference This JSON response contains a list of accounts, each with details like bucket_id, account_id, customer_id, and other relevant information. It also includes metadata for pagination. ```json { "data": [ { "bucket_id": "714143be-b24d-4771-8a85-3819df97205e", "account_id": "029d224e-f629-48c4-bd45-46e1a6a1e59a", "customer_id": 1170415646270294300, "country_code": "GB", "currency_code": "EUR", "nature": "account", "provider_code": "some_provider_code", "holder_name": "Holder Name", "external_id": null, "extra": { "some_key": "some_value" } }, { "bucket_id": "714143be-b24d-4771-8a85-3819df97205e", "account_id": "28f304b2-4771-8a85-3819df97205e", "customer_id": 1170415646270294300, "country_code": "GB", "currency_code": "EUR", "nature": "account", "provider_code": "some_provider_code", "holder_name": "Holder Name", "external_id": null, "extra": { "some_key": "some_value" } }, { "bucket_id": "714143be-b24d-4771-8a85-3819df97205e", "account_id": "6596bb4e-3708-478a-b1f5-b917d1680016", "customer_id": 1170415646270294300, "country_code": "GB", "currency_code": "EUR", "nature": "account", "provider_code": "some_provider_code", "holder_name": "Holder Name", "external_id": null, "extra": { "some_key": "some_value" } } ], "meta": { "next_id": "6925f584-41f0-40b4-81de-77606a4b23f4", "next_page": "/api/v6/categorization/accounts?per_page=1000&from_id=6925f584-41f0-40b4-81de-77606a4b23f4&customer_id=1170415646270294289" } } ``` -------------------------------- ### Success Callback Example Source: https://docs.saltedge.com/v6/api_reference A success callback is sent when an operation changes data for a connection. This example shows the payload structure including connection and customer IDs, custom fields, and the stage of the operation. ```json { "data": { "connection_id": "111111111111111111", "customer_id": "222222222222222222", "custom_fields": { "key": "value" }, "stage": "finish" }, "meta": { "version": "6", "time": "2024-01-25T10:40:47.965Z" } } ``` -------------------------------- ### Create Customer using cURL Source: https://docs.saltedge.com/v6/api_reference Use this cURL command to send a POST request to create a new customer. Ensure to replace $APP_ID and $SECRET with your actual credentials. ```bash curl -v -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "App-id: $APP_ID" \ -H "Secret: $SECRET" \ -X POST \ -d "{ \ \"data\": { \ \"email\": \"email@email.com\", \ \"kyc\": { \ \"citizenship_code\": \"GB\", \ \"date_of_birth\": \"2001-01-01\", \ \"full_name\": \"John Doe\", \ \"gender\": \"male\", \ \"legal_name\": \"Example Company Name\", \ \"place_of_birth\": \"London\", \ \"registered_office_code\": \"GB\", \ \"registered_office_address\": \"London, Independence str, block 5\", \ \"registration_number\": \"12345\", \ \"residence_address\": \"London, Independence str, block 5\", \ \"type_of_account\": \"own\" \ } \ } \ }" \ https://www.saltedge.com/api/v6/customers ``` -------------------------------- ### Update Connection Settings using PUT Source: https://docs.saltedge.com/v6/api_reference This example demonstrates how to update connection settings like automatic refresh, categorization, status, and credential storage using a PUT request. Ensure the connection_id is correctly specified. ```bash curl -v -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "App-id: $APP_ID" \ -H "Secret: $SECRET" \ -X PUT \ -d "automatic_refresh=true&categorization=personal&status=inactive&store_credentials=false" \ https://www.saltedge.com/api/v6/connections/11111111111111 ``` -------------------------------- ### GET /categories Source: https://docs.saltedge.com/v6/api_reference Retrieves a list of all supported personal and business categories. ```APIDOC ## GET /categories ### Description Fetches a list of all supported categories, which can be either personal or business types. Multiple categories may be returned for any operation. ### Method GET ### Endpoint https://www.saltedge.com/api/v6/categories ### Request Example ```json { "example": "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/v6/categories" } ``` ``` -------------------------------- ### Create Customer Source: https://docs.saltedge.com/v6/api_reference Creates a new customer with the provided details. Requires email and optionally KYC information. ```APIDOC ## POST /api/v6/customers ### Description Creates a new customer with the provided details. Requires email and optionally KYC information. ### Method POST ### Endpoint https://www.saltedge.com/api/v6/customers ### Parameters #### Request Body Parameters - **email** (string) - mandatory - A unique `email` of the User assigned by the Partner - **kyc** (object) - optional - Hide child attributes - **citizenship_code** (string) - optional - Possible values: country code as mentioned in ISO 3166-1 alpha-2 - **date_of_birth** (string) - optional - (date) - **full_name** (string) - optional - **gender** (string) - optional - Possible values: `male`, `female`, `other` - **legal_name** (string) - optional - **place_of_birth** (string) - optional - **registered_office_code** (string) - optional - Possible values: country code as dated in ISO 3166-1 alpha-2 - **registered_office_address** (string) - optional - **registration_number** (string) - optional - **residence_address** (string) - optional - **type_of_account** (string) - optional ### Request Example ```json { "data": { "email": "email@email.com", "kyc": { "citizenship_code": "GB", "date_of_birth": "2001-01-01", "full_name": "John Doe", "gender": "male", "legal_name": "Example Company Name", "place_of_birth": "London", "registered_office_code": "GB", "registered_office_address": "London, Independence str, block 5", "registration_number": "12345", "residence_address": "London, Independence str, block 5", "type_of_account": "own" } } } ``` ### Response #### Success Response (200) - **data** (object) - **email** (string) - **customer_id** (string) - **identifier** (string) - **blocked_at** (null) - **created_at** (string) - **updated_at** (string) #### Response Example ```json { "data": { "email": "example@email.com", "customer_id": "111111111111111111", "identifier": "example_identifier", "blocked_at": null, "created_at": "2023-02-08T14:06:41Z", "updated_at": "2023-02-08T14:06:41Z" } } ``` ### Possible errors Error Class| HTTP code| Description ---|---|--- DuplicatedCustomer| 409| The User being attempted to be created already exists WrongRequestFormat| 400| Some parameters or the entire JSON request are in the wrong format ``` -------------------------------- ### GET /customers/{id} Source: https://docs.saltedge.com/v6/api_reference Returns the customer object for a given customer ID. ```APIDOC ## GET /customers/{id} ### Description Returns the customer object for a given customer ID. ### Method GET ### Endpoint https://www.saltedge.com/api/v6/customers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the customer. ### Response #### Success Response (200) - **data** (object) - Contains customer details. - **customer_id** (string) - The unique identifier for the customer. - **identifier** (string) - An identifier for the customer. - **categorization_type** (string) - The categorization type of the customer, or null. - **blocked_at** (string) - Timestamp when the customer was blocked, or null. - **created_at** (string) - Timestamp of customer creation. - **updated_at** (string) - Timestamp of last customer update. #### Response Example ```json { "data": { "customer_id": "111111111111111111", "identifier": "example@email.com", "categorization_type": null, "blocked_at": null, "created_at": "2023-02-08T14:06:41Z", "updated_at": "2023-02-08T14:06:41Z" } } ``` ``` -------------------------------- ### GET /customers Source: https://docs.saltedge.com/v6/api_reference Returns a list of all customers associated with the application. Supports pagination. ```APIDOC ## GET /customers ### Description Returns a list of all customers associated with the application. Supports pagination. ### Method GET ### Endpoint https://www.saltedge.com/api/v6/customers ### Parameters #### Query Parameters - **from_id** (integer) - Optional - The `id` of the Customer the list starts with. - **per_page** (integer) - Optional - The number of Customers to be listed per page. ### Response #### Success Response (200) - **data** (array) - A list of customer objects. - **customer_id** (string) - The unique identifier for the customer. - **identifier** (string) - An identifier for the customer. - **categorization_type** (string) - The categorization type of the customer, or null. - **blocked_at** (string) - Timestamp when the customer was blocked, or null. - **created_at** (string) - Timestamp of customer creation. - **updated_at** (string) - Timestamp of last customer update. - **meta** (object) - Metadata for pagination. - **next_id** (string) - The ID for the next page of results. - **next_page** (string) - The URL for the next page of results. #### Response Example ```json { "data": [ { "customer_id": "1111111111111111111", "identifier": "email@email.com", "categorization_type": null, "blocked_at": null, "created_at": "2021-09-14T15:14:34Z", "updated_at": "2021-09-14T15:14:34Z" }, { "customer_id": "2222222222222222222", "identifier": "some_identifier", "categorization_type": null, "blocked_at": null, "created_at": "2021-09-14T18:04:11Z", "updated_at": "2021-09-14T18:04:11Z" } ], "meta": { "next_id": "3333333333333333333", "next_page": "/api/v6/customers?from_id=3333333333333333333" } } ``` ``` -------------------------------- ### List Connections GET Request Source: https://docs.saltedge.com/v6/api_reference Use this cURL command to fetch a list of Connections for a specific customer. Ensure you replace placeholder values like $APP_ID and $SECRET with your actual credentials. You can also specify 'from_id' and 'per_page' for pagination. ```bash 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/v6/connections?customer_id=111111111?from_id=111111111?per_page=120 ``` -------------------------------- ### Sample Request Response for Learning Categories Source: https://docs.saltedge.com/v6/api_reference This is a sample response indicating the success of learning a transaction category. ```json { "data": { "learned": true } } ``` -------------------------------- ### Sample Delete Report Response Source: https://docs.saltedge.com/v6/api_reference This is an example of the JSON response when a report is successfully deleted. ```json { "data": { "id": "509574324735183486", "deleted": true } } ``` -------------------------------- ### Get Customer Response Source: https://docs.saltedge.com/v6/api_reference Sample JSON response for a successful customer retrieval request. ```json { "data": { "customer_id": "111111111111111111", "identifier": "email@email.com", "blocked_at": null, "created_at": "2023-02-08T14:06:41Z", "updated_at": "2023-02-08T14:06:41Z" } } ``` -------------------------------- ### Create Payment Source: https://docs.saltedge.com/v6/api_reference Initiates a payment process using the Salt Edge Widget. A `payment_url` is returned upon successful request execution, which redirects the user to start the payment. ```APIDOC ## POST /payments ### Description Streamlines the Payment Initiation via Payment Initiation API facilitated by Salt Edge Widget, which automates User authentication. Upon successful request execution, a `payment_url` is returned. Redirecting the User to this URL initiates the Payment process. ### Method POST ### Endpoint https://www.saltedge.com/api/v6/payments ### Parameters #### Request Body Parameters - **payment_attributes** (object) - Required - All the attributes (both required and optional) that are needed for a successful Payment Initiation for a specific `payment_template`. - **template_identifier** (string) - Required - The Payment template identifier. Possible values: all supported payment templates. - **customer_id** (string) - Optional - A unique `id` of the Customer to which the Payment belongs. - **customer_identifier** (string) - Optional - If `customer_id` is not sent and this field is sent, find or create such a Customer using this identifier. ### Request Example ```json { "payment_attributes": { "amount": "10.00", "currency_code": "EUR" }, "template_identifier": "some_template_id", "customer_id": "12345" } ``` ### Response #### Success Response (200) - **data** (object) - Contains details of the created payment, including the payment URL. - **payment_url** (string) - The URL to redirect the user to initiate the payment. - **payment** (object) - Details of the created payment (attributes described in the 'Payments' section above). #### Response Example ```json { "data": { "payment_url": "https://widget.saltedge.com/payments/abcdef123456", "payment": { "id": "123", "customer_id": "12345", "provider_code": "some_provider_es", "provider_name": "Some Provider", "refresh_interval": 3600, "refresh_timeout": 86400, "status": "initiated", "raw_provider_status": null, "template_identifier": "some_template_id", "payment_attributes": { "amount": "10.00", "currency_code": "EUR" }, "last_attempt": null, "created_at": "2023-10-27T10:00:00Z", "updated_at": "2023-10-27T10:00:00Z" } } } ``` ``` -------------------------------- ### Get Specific Consent Source: https://docs.saltedge.com/v6/api_reference Retrieves a single consent object by its ID. Requires connection_id or customer_id. ```bash 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/v6/consents/111111111111111111?connection_id=11111111111111111111111&customer_id=222222222222222222 ``` -------------------------------- ### Create a Payment Source: https://docs.saltedge.com/v6/api_reference Use this snippet to create a new payment. It requires various attributes including creditor IBAN, amount, template identifier, customer details, and provider information. The widget configuration allows customization of the payment flow. ```curl curl -v -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "App-id: $APP_ID" \ -H "Secret: $SECRET" \ -X POST \ -d "{ \ \"data\": { \ \"payment_attributes\": { \ \"creditor_iban\": \"GB33BUKB20201555555555\", \ \"amount\": \"199000.00\" \ }, \ \"template_identifier\": \"SEPA\", \ \"customer_id\": 11111111111111112, \ \"customer_identifier\": \"CustomeIdentifier\", \ \"provider\": { \ \"code\": \"fake_client_xf\", \ \"include_sandboxes\": false \ }, \ \"return_error_class\": true, \ \"return_payment_id\": false, \ \"widget\": { \ \"template\": \"connectpay\", \ \"theme\": \"dark\", \ \"javascript_callback_type\": \"post_message\", \ \"disable_provider_search\": true, \ \"skip_provider_selection\": true, \ \"show_consent_confirmation\": false, \ \"allowed_countries\": [ \ \"XF\", \ \"DE\", \ \"IT\" \ ] \ }, \ \"attempt\": { \ \"cancellation_scopes\": [ \ \"timeout\", \ \"insufficient_funds\" \ ], \ \"custom_fields\": {}, \ \"return_to\": \"http://example.com/\", \ \"locale\": \"EN\" \ } \ } \ }" \ https://www.saltedge.com/api/v6/payments/create ``` -------------------------------- ### Sample Report Data Response Source: https://docs.saltedge.com/v6/api_reference This is an example of the JSON response structure when successfully fetching report data. ```json { "data": { "id": "111111111111111", "customer_id": "222222222222222", "customer_identifier": "some_customer_identifier", "connection_ids": [ "3333333333333333", "4444444444444444444" ], "status": "initialized", "currency_code": "EUR", "from_date": "2024-01-01", "to_date": "2024-01-31", "report_types": [ "balance", "expense", "income" ], "include_account_natures": [ "account", "bonus", "card" ], "created_at": "2024-01-01", "updated_at": "2024-01-01", "data": {} } } ```