### GET Request Signature String Example

Source: https://docs.saltedge.com/v6

Example of the string format used to generate a signature for a GET request.

```text
1413802718|GET|https://www.saltedge.com/api/v6/providers?from_id=123|
```

--------------------------------

### Bulk Payment Example

Source: https://docs.saltedge.com/assets/swagger-v6.json

This example demonstrates the structure of a successful response for a bulk payment creation. It includes details about payment attributes and status.

```json
{
  "data": {
    "bulk_payment": {
      "id": "1111111111111111111",
      "created_at": "2025-04-18T13:46:40Z",
      "updated_at": "2025-04-18T13:46:40Z",
      "refresh_interval": 3600,
      "refresh_timeout": 172800,
      "status": "authorizing",
      "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": {}
      }
    }
  }
}
```

--------------------------------

### POST Request Signature String Example

Source: https://docs.saltedge.com/v6

Example of the string format used to generate a signature for a POST request.

```text
1413802718|POST|https://www.saltedge.com/api/v6/customers/|{"data":{"identifier":"my_unique_identifier"}}
```

--------------------------------

### Example String for Signature Generation

Source: https://docs.saltedge.com/v6

This example shows the concatenated string format used for generating the SHA256 signature for callback requests. It includes the callback URL and the JSON post body.

```text
https://www.client.com/api/callbacks/success|{"data":{"connection_id":"111111111111111111","customer_id":"222222222222222222","custom_fields":{}},"meta":{"version":"6","time":"2020-07-07T13:00:28Z"}}
```

--------------------------------

### Notify Callback Example

Source: https://docs.saltedge.com/v6/api_reference

An example of a Notify callback payload sent to the client's 'notify' URL, indicating the progress stage 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"
    }
  }
```

--------------------------------

### Sample Response for Showing a Customer Rule

Source: https://docs.saltedge.com/v6/api_reference

Example JSON response when retrieving a single customer rule.

```json
{
  "data": {
    "id": 123456,
    "rule": "Sample Rule-123",
    "processed_rule": "sample rule",
    "category": "software"
  }
}
```

--------------------------------

### Sample Response for Listing Customer Rules

Source: https://docs.saltedge.com/v6/api_reference

Example JSON response when listing customer rules, showing rule data and metadata.

```json
{
  "data": [
    {
      "id": 123456,
      "rule": "Sample Rule-123",
      "processed_rule": "sample rule",
      "category": "software"
    },
    {
      "id": 123457,
      "rule": "Nouvelle règle",
      "processed_rule": "nouvelle regle",
      "category": "custom category"
    }
  ],
  "meta": {
    "next_id": null,
    "per_page": null
  }
}
```

--------------------------------

### Destroy Callback Example

Source: https://docs.saltedge.com/v6/api_reference

An example of a Destroy callback payload sent to the client's 'destroy' URL when a connection is removed.

```json
{
    "data": {
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
        "custom_fields": { "key": "value" },
    },
    "meta": {
      "version": "6",
      "time": "2024-01-24T10:40:48Z"
    }
  }
```

--------------------------------

### List Accounts GET Request

Source: https://docs.saltedge.com/v6/api_reference

Demonstrates how to list accounts using the GET method. Requires App-id and Secret headers, and either customer_id or bucket_id. Optional parameters like per_page and from_id can be used for pagination.

```curl
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/categorization/accounts?bucket_id=714143be-b24d-4771-8a85-3819df97205e&customer_id=1170415646270294289&per_page=100&from_id=6925f584-41f0-40b4-81de-77606a4b23f4
```

--------------------------------

### Sample Provider Response

Source: https://docs.saltedge.com/v6/api_reference

This is an example of a successful response when retrieving provider details. It includes various attributes of the provider.

```json
{
  "data": {
    "id": "3099",
    "code": "fake_oauth_client_xf",
    "country_code": "XF",
    "bic_codes": [],
    "dynamic_registration_code": null,
    "identification_codes": [],
    "group_code": "fake",
    "group_name": "Fake",
    "hub": null,
    "name": "Fake OAuth Bank with Client Keys",
    "status": "active",
    "mode": "oauth",
    "regulated": true,
    "logo_url": "https://d1uuj3mi6rzwpm.cloudfront.net/logos/providers/xf/placeholder_global.svg",
    "home_url": "https://example.com",
    "login_url": "https://example.com",
    "timezone": "UTC",
    "supported_iframe_embedding": true,
    "optional_interactivity": true,
    "customer_notified_on_sign_in": false,
    "created_at": "2018-04-12T14:30:29Z",
    "updated_at": "2024-03-06T07:47:56Z"
  }
}
```

--------------------------------

### Create Customer with Partner Details

Source: https://docs.saltedge.com/v6/api_reference

This method is used to create a customer by providing their email and Know Your Customer (KYC) information. The KYC object can include details such as citizenship, date of birth, full name, gender, legal name, place of birth, registered office details, registration number, residential address, and account type.

```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
```

--------------------------------

### Get Country Details

Source: https://docs.saltedge.com/assets/swagger-v6.json

Retrieves details about a specific country, including its ISO code and refresh start time.

```APIDOC
## GET /country/{code}

### Description
Retrieves details about a specific country.

### Method
GET

### Endpoint
/country/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - The ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB').

### Response
#### Success Response (200)
- **data** (object) - Contains the country details.
  - **name** (string) - Name of the country.
  - **code** (string) - Country code as dated in ISO 3166-1 alpha-2.
  - **refresh_start_time** (integer) - Local country time when connections will be automatically refreshed.

#### Response Example
```json
{
  "data": {
    "name": "United States",
    "code": "US",
    "refresh_start_time": 3
  }
}
```
```

--------------------------------

### CreatePOST

Source: https://docs.saltedge.com/v6/api_reference

Initiates a bulk payment process using the Payment Initiation API. The Salt Edge Widget automates user authentication, and a `bulk_payment_url` is returned upon successful request execution, which redirects the user to start the process.

```APIDOC
## POST /bulk_payments

### Description
Streamlines the Bulk Payment Initiation via Payment Initiation API using the Salt Edge Widget for automated user authentication. A `bulk_payment_url` is returned upon successful request execution, which redirects the User to initiate the Bulk Payment process.

### Method
POST

### Endpoint
/bulk_payments

### Parameters
#### Request Body
- **payment_attributes** (object) - mandatory - All the attributes (both required and optional) that are needed for a successful Payment Initiation for a specific `payment_template`
  - **creditors_attributes** (array) - mandatory - Array which contains values about creditor distinct for each payment from bulk
  - **shared_payment_attributes** (object) - mandatory - Hash which contains common values for all payments from bulk
- **template_identifier** (string) - mandatory - The Bulk Payment template identifier. Possible values: SEPA
- **customer_id** (integer) - A unique `id` of the Customer to which the Payment belongs
- **customer_identifier** (string) - If `customer_id` is not sent and this field is sent, find or create such a Customer using this identifier.
- **provider** (object) - 
  - **code** (string) - mandatory - The code of the required Provider
- **return_error_class** (boolean) - Append `error_class` to `return_to` URL. Default value: `false`
- **return_bulk_payment_id** (boolean) - Append `bulk_payment_id` to return_to URL. Default value: `false`
- **widget** (object) - 
  - **template** (string) - Allows Clients and Partners to configure a template for the Widget. By default, Clients use `default_v3` and Partners use `partner_v3`.
  - **theme** (string) - Allows Clients to specify a color theme for the Widget. If not set, the Widget uses the User's operating system theme preference by default. Possible values: `dark`, `default`, `light`. Default value: `default`
  - **javascript_callback_type** (string) - How the Widget interacts with the opener/ parent window. Possible values: `iframe`, `post_message`
  - **show_consent_confirmation** (boolean) - Shows confirmation of the Connection. Default value: `true`
  - **skip_final_screen** (boolean) - Allows Users to skip the error, success and confirmation screens. Default value: `false`
  - **skip_processing_screen** (boolean) - Allows Users to skip the Payment processing screen after receiving the authorized status from the Provider. Default value: `false`
- **attempt** (object) - 
  - **custom_fields** (object) - A JSON object which will be sent back on any of the Client’s callbacks
  - **return_to** (string) - The URL to which the User will be redirected. By default, this is the Client’s or Partner’s home URL
  - **locale** (string) - The language of the Widget and the language of the returned error message(s). Possible values: any locale ISO 639-1 format

### Response
#### Success Response (200)
- **bulk_payment_url** (string) - The URL to redirect the user to initiate the bulk payment process.

### Request Example
{
  "payment_attributes": {
    "creditors_attributes": [
      {
        "creditor_identifier": "string",
        "end_to_end_identification": "string",
        "instructed_amount": {
          "amount": "10.00",
          "currency": "EUR"
        },
        "remittance_information": {
          "unstructured": "string"
        }
      }
    ],
    "shared_payment_attributes": {
      "debtor_account": {
        "iban": "string"
      },
      "requested_execution_date": "YYYY-MM-DD"
    }
  },
  "template_identifier": "SEPA",
  "customer_id": 123,
  "provider": {
    "code": "provider_code"
  },
  "widget": {
    "theme": "dark",
    "javascript_callback_type": "post_message"
  },
  "attempt": {
    "return_to": "https://example.com/return",
    "locale": "en"
  }
}

### Response Example
{
  "bulk_payment_url": "https://widget.saltedge.com/bulk_payments/abcdef1234567890"
}
```

--------------------------------

### List of Rates

Source: https://docs.saltedge.com/assets/swagger-v6.json

Retrieves a list of all supported currency rates. Rates are available starting from March 21, 2014. You can specify a date to get rates for a particular day.

```APIDOC
## GET /rates

### Description
You can get the list of all the currency rates that we support.
You will receive the currency rates starting March 21, 2014.
If any older date is requested, you will still receive the rates starting March 21, 2014.

### Method
GET

### Endpoint
/rates

### Parameters
#### Query Parameters
- **date** (string) - Optional - The currency rate for a specific date is returned. Possible values: any date in the `YYYY-MM-DD` format. Default value: current date.

### Response
#### Success Response (200)
- **data** (array) - List of currency rates.
  - **currency_code** (string) - The currency code.
  - **rate** (number) - The currency rate.
  - **fail** (boolean) - Indicates if there was an error fetching the rate.
- **meta** (object)
  - **issued_on** (string) - The date the rates were issued.

### Response Example
```json
{
  "data": [
    {
      "currency_code": "AED",
      "rate": 0.2722652206,
      "fail": false
    },
    {
      "currency_code": "AFN",
      "rate": 0.0135567167,
      "fail": false
    }
  ],
  "meta": {
    "issued_on": "2025-01-01"
  }
}
```
```

--------------------------------

### Create Connection

Source: https://docs.saltedge.com/v6/api_reference

Initiates a new connection to a financial institution. This endpoint allows users to start the process of connecting their accounts by providing necessary details for consent and connection setup.

```APIDOC
## POST /v6/connections/connect

### Description
Initiates a new connection to a financial institution. This endpoint allows users to start the process of connecting their accounts by providing necessary details for consent and connection setup.

### Method
POST

### Endpoint
https://www.saltedge.com/api/v6/connections/connect

### Request Body
- **data** (object) - Required - Contains all parameters for the connection request.
  - **customer_id** (integer) - Required - The ID of the customer for whom the connection is being created.
  - **consent** (object) - Optional - Consent details for data access.
    - **scopes** (array of strings) - Required - The types of data to be accessed (e.g., "accounts", "holder_info").
    - **from_date** (string) - Optional - The start date for data retrieval in YYYY-MM-DD format.
    - **to_date** (string) - Optional - The end date for data retrieval in YYYY-MM-DD format.
    - **period_days** (integer) - Optional - The duration in days for which data should be retrieved.
  - **attempt** (object) - Optional - Details for the connection attempt.
    - **fetch_scopes** (array of strings) - Optional - Specific scopes to fetch during this attempt.
    - **fetch_from_date** (string) - Optional - Start date for fetching data in YYYY-MM-DD format.
    - **fetch_to_date** (string) - Optional - End date for fetching data in YYYY-MM-DD format.
    - **account_natures** (array of strings) - Optional - Types of accounts to consider (e.g., "account", "bonus").
    - **custom_fields** (object) - Optional - Custom fields for the attempt.
    - **locale** (string) - Optional - The locale for the connection process (e.g., "DE").
    - **store_credentials** (boolean) - Optional - Whether to store user credentials.
    - **unduplication_strategy** (string) - Optional - Strategy to handle duplicated data (e.g., "delete_duplicated").
    - **return_to** (string) - Optional - URL to redirect the user after the process.
  - **widget** (object) - Optional - Configuration for the Salt Edge Connect widget.
    - **show_account_overview** (boolean) - Optional - Whether to show the account overview screen.
    - **show_consent_confirmation** (boolean) - Optional - Whether to show the consent confirmation screen.
    - **credentials_strategy** (string) - Optional - Strategy for handling credentials (e.g., "ask").
    - **javascript_callback_type** (string) - Optional - Type of JavaScript callback (e.g., "iframe").
    - **disable_provider_search** (boolean) - Optional - Whether to disable provider search.
    - **skip_provider_selection** (boolean) - Optional - Whether to skip provider selection.
    - **skip_stages_screen** (boolean) - Optional - Whether to skip the stages screen.
    - **template** (string) - Optional - The widget template to use (e.g., "default_v3").
    - **theme** (string) - Optional - The widget theme (e.g., "default").
    - **allowed_countries** (array of strings) - Optional - List of allowed countries for providers.
    - **popular_providers_country** (string) - Optional - Country to prioritize for popular providers.
  - **provider** (object) - Optional - Specific provider details.
    - **code** (string) - Required if specified - The code of the provider (e.g., "fake_oauth_client_xf").
    - **include_sandboxes** (boolean) - Optional - Whether to include sandbox environments.
    - **modes** (array of strings) - Optional - Connection modes to use (e.g., "oauth").
    - **regulated** (boolean) - Optional - Whether the provider is regulated.
  - **kyc** (object) - Optional - Know Your Customer information.
    - **type_of_account** (string) - Optional - The type of account (e.g., "personal").
  - **return_connection_id** (boolean) - Optional - Whether to return the connection ID in the response.
  - **return_error_class** (boolean) - Optional - Whether to return the error class in the response.
  - **categorization** (string) - Optional - Categorization type (e.g., "personal").
  - **categorization_vendor** (string) - Optional - Vendor for categorization (e.g., "saltedge").
  - **automatic_refresh** (boolean) - Optional - Whether to enable automatic refresh.

### Request Example
```json
{
  "data": {
    "customer_id": 111111111111,
    "consent": {
      "scopes": [
        "accounts",
        "holder_info"
      ],
      "from_date": "2023-11-05",
      "to_date": "2023-11-20",
      "period_days": 15
    },
    "attempt": {
      "fetch_scopes": [
        "holder_info",
        "accounts"
      ],
      "fetch_from_date": "2023-09-30",
      "fetch_to_date": "2023-10-25",
      "account_natures": [
        "account",
        "bonus",
        "card",
        "checking"
      ],
      "custom_fields": {},
      "locale": "DE",
      "store_credentials": true,
      "unduplication_strategy": "delete_duplicated",
      "return_to": "http://example.com"
    },
    "widget": {
      "show_account_overview": true,
      "show_consent_confirmation": false,
      "credentials_strategy": "ask",
      "javascript_callback_type": "iframe",
      "disable_provider_search": false,
      "skip_provider_selection": false,
      "skip_stages_screen": true,
      "template": "default_v3",
      "theme": "default",
      "allowed_countries": [
        "XF",
        "GB",
        "DE"
      ],
      "popular_providers_country": "XF"
    },
    "provider": {
      "code": "fake_oauth_client_xf",
      "include_sandboxes": true,
      "modes": [
        "oauth"
      ],
      "regulated": true
    },
    "kyc": {
      "type_of _account": "personal"
    },
    "return_connection_id": false,
    "return_error_class": true,
    "categorization": "personal",
    "categorization_vendor": "saltedge",
    "automatic_refresh": true
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains connection details.
  - **expires_at** (string) - The expiration time of the connection token.
  - **connect_url** (string) - The URL to initiate the connection process.
  - **customer_id** (string) - The ID of the customer.

#### Response Example
```json
{
  "data": {
    "expires_at": "2024-02-19T17:07:59Z",
    "connect_url": "https://www.saltedge.com/connect?token=78abc19673b5978ec2bed15bc7b395e5f4775ccfbc78ecf45cc41e64a9ac51d46",
    "customer_id": "1111111111111111111111"
  }
}
```
```

--------------------------------

### List Payment Templates

Source: https://docs.saltedge.com/assets/swagger-v6.json

This example shows a successful response when listing available payment templates. It includes identifiers and descriptions for different payment types like BACS and CHAPS.

```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
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### List Transactions GET Request

Source: https://docs.saltedge.com/v6/api_reference

Use this cURL command to retrieve transactions. Ensure you replace placeholders like $APP_ID and $SECRET with your actual credentials. The parameters allow filtering by connection, account, duplication status, pending status, starting ID, and page size.

```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
```

--------------------------------

### Show Payment Template

Source: https://docs.saltedge.com/assets/swagger-v6.json

This example displays a specific payment template, in this case, CHAPS. It details the fields required for this payment type, including optional and mandatory fields.

```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
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Create Customer with Partner Email and KYC

Source: https://docs.saltedge.com/v6/api_reference

This endpoint allows creating a customer with an email provided by the partner and detailed Know Your Customer (KYC) information. The `email` is mandatory. Ensure all KYC fields are correctly formatted according to the specified types and possible values.

```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
```

--------------------------------

### Consent Status Callback Example

Source: https://docs.saltedge.com/v6/api_reference

An example of a Consent Status callback payload indicating a change in consent status, such as 'revoked'.

```json
{
    "data": {
      "consent_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "connection_id": "3333333333333333333",
      "custom_fields": {
        "key": "value"
      },
      "consent_status": "revoked",
      "reason": "provider"
    },
    "meta": {
      "version": "6",
      "time": "2026-04-25T10:40:47.965Z"
    }
  }
```

--------------------------------

### Provider Changes Callback Example

Source: https://docs.saltedge.com/v6/api_reference

An example of a Provider Changes callback payload sent when a provider's status changes, such as becoming 'inactive'.

```json
{
    "data": {
      "provider_status": "inactive",
      "provider_code": "fake_client_xf"
    },
    "meta": {
      "version": 5,
      "time": "2023-09-21T09:49:13.472Z"
    }
  }
```

--------------------------------

### Create Payment

Source: https://docs.saltedge.com/assets/swagger-v6.json

This example shows a successful response after creating a new payment. It provides the payment URL, customer ID, and the unique payment ID.

```json
{
  "data": {
    "expires_at": "2024-02-19T20:42:56Z",
    "payment_url": "https://www.saltedge.com/payments/connect?token=de9ce7f81424ee83867c7684987948f2443bf0df5509vndrcb7ebf37e918ee0456ef",
    "customer_id": "1111111111111111111",
    "payment_id": "1111111111111111111"
  }
}
```

--------------------------------

### Create Bucket Response

Source: https://docs.saltedge.com/v6/api_reference

Sample response after successfully creating a bucket for standalone categorization. It includes the bucket ID, customer ID, and the initial status.

```json
{
  "data": {
    "bucket_id": "some string identifier",
    "customer_id": "180",
    "status": "pending"
  }
}
```

--------------------------------

### Success Callback Example

Source: https://docs.saltedge.com/v6/api_reference

A success callback is sent when an operation changes data for a specific connection. This example shows the typical payload including connection and customer IDs, custom fields, and the current stage.

```json
{
    "data": {
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "custom_fields": { "key": "value" },
      "stage": "finish"
    },
    "meta": {
      "version": "6",
      "time": "2024-01-25T10:40:47.965Z"
    }
  }


```

--------------------------------

### Sample Accounts List Response

Source: https://docs.saltedge.com/v6/api_reference

This is a sample JSON response when successfully retrieving a list of accounts. It includes account details such as ID, connection ID, name, balance, currency, and an 'extra' object containing provider-specific information. The 'meta' object provides pagination details like `next_id` and `next_page`.

```json
{
  "data": [
    {
      "id": "1111111111111111111",
      "connection_id": "1111111111111111111",
      "name": "Simple account 1 MasterCard",
      "nature": "card",
      "balance": 2007.9,
      "currency_code": "EUR",
      "extra": {
        "iban": "DE5555555555555555555555",
        "swift": "ABCDEFGH",
        "status": "active",
        "card_type": "master_card",
        "sort_code": "65-43-21",
        "holder_name": "John DOE",
        "account_name": "123456",
        "current_date": "2021-09-14",
        "current_time": "18:04:00",
        "account_number": "123456",
        "transactions_count": {
          "posted": 4,
          "pending": 0
        },
        "updated_on_last_attempt": true
      },
      "created_at": "2021-09-14T18:04:48Z",
      "updated_at": "2021-09-14T18:04:48Z"
    },
    {
      "id": "2222222222222222222",
      "connection_id": "1111111111111111111",
      "name": "Simple account 2",
      "nature": "account",
      "balance": 2012.14,
      "currency_code": "USD",
      "extra": {
        "iban": "DE77777777777777",
        "cards": [
          "1234....5678",
          "*8765"
        ],
        "swift": "ABCDEFGJ",
        "status": "active",
        "sort_code": "65-43-22",
        "holder_name": "John Doe",
        "account_name": "123457",
        "current_date": "2021-09-14",
        "current_time": "18:04:00",
        "account_number": "123457",
        "transactions_count": {
          "posted": 5,
          "pending": 0
        },
        "updated_on_last_attempt": false
      },
      "created_at": "2021-09-14T18:04:48Z",
      "updated_at": "2021-09-14T18:04:48Z"
    }
  ],
  "meta": {
    "next_id": "3333333333333333333",
    "next_page": "/api/v6/accounts?connection_id=1111111111111111111&from_id=3333333333333333333"
  }
}
```

--------------------------------

### Get Supported Currency Rates

Source: https://docs.saltedge.com/v6/api_reference

Use this endpoint to retrieve a list of all supported currency rates. You can optionally specify a date to get rates for a particular day. Ensure your request includes the necessary authentication headers.

```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/rates?date=2022-01-01
```

--------------------------------

### Background Refresh Response Example

Source: https://docs.saltedge.com/v6/api_reference

This is a sample JSON response received after initiating a background refresh. It includes details about the connection, such as its ID, provider, status, and refresh settings. It also contains information about the last refresh attempt, including its ID, status, fetch parameters, and timestamps.

```json
{
  "data": {
    "id": "1111111111111111111",
    "customer_id": "1191191191191191191",
    "customer_identifier": "example_identifier",
    "provider_code": "fake_oauth_client_xf",
    "provider_name": "Fake OAuth Bank with Client Keys",
    "country_code": "XF",
    "status": "inactive",
    "categorization": "personal",
    "automatic_refresh": true,
    "store_credentials": true,
    "next_refresh_possible_at": null,
    "created_at": "2024-03-25T13:20:53Z",
    "updated_at": "2024-03-25T13:29:09Z",
    "last_consent_id": "1241241241241241241",
    "last_attempt": {
      "id": "1221122112211221122",
      "consent_id": "1241241241241241241",
      "api_version": "6",
      "api_mode": "service",
      "automatic_fetch": false,
      "categorize": true,
      "custom_fields": {
        "id2": "value",
        "id3": "value",
        "id4": "value"
      },
      "automatic_refresh": true,
      "exclude_accounts": [],
      "fetch_from_date": "2024-01-25",
      "fetch_to_date": "2024-01-25",
      "fetch_scopes": [
        "accounts",
        "holder_info",
        "transactions"
      ],
      "finished": false,
      "finished_recent": false,
      "include_natures": [
        "account"
      ],
      "interactive": false,
      "locale": "en",
      "partial": false,
      "show_consent_confirmation": false,
      "store_credentials": true,
      "user_present": false,
      "user_agent": null,
      "device_type": "desktop",
      "remote_ip": "127.0.0.1",
      "customer_last_logged_at": null,
      "created_at": "2024-03-25T13:29:09Z",
      "updated_at": "2024-03-25T13:29:09Z",
      "success_at": null,
      "fail_at": null,
      "fail_error_class": null,
      "fail_message": null,
      "last_stage": {
        "id": "1212121212121212121",
        "name": "initialize",
        "created_at": "2024-03-25T13:29:09Z",
        "updated_at": "2024-03-25T13:29:09Z"
      }
    }
  }
}
```

--------------------------------

### Get Payments

Source: https://docs.saltedge.com/assets/swagger-v6.json

Retrieves a list of payments.

```APIDOC
## GET /payments

### Description
Retrieves a list of payments.

### Method
GET

### Endpoint
/payments

### Parameters
#### Query Parameters
- **customer_id** (string) - Optional - Filter payments by customer ID.

### Response
#### Success Response (200)
- **data** (object) - Contains the payment details.
```