Salt Edge

https://docs.saltedge.com/
Admin
Salt Edge is an Open Banking API platform that provides Account Information Services (AIS) and...
Tokens:176,872
Snippets:1,036
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Sample response for GET /providers/{provider_code}

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

Example JSON response returned by the Show Provider endpoint. It contains the provider's details such as id, code, country_code, name, status, mode, and timestamps.

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

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

### Start Categorization - Sample curl request

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

Sample request to start categorization for a bucket. Uses the categorization_type 'personal' and categorization_vendor 'saltedge'. Requires APP_ID and SECRET environment variables.

```bash
curl -v -H "Accept: application/json" \
         -H "Content-type: application/json" \
         -H "App-id: $APP_ID" \
         -H "Secret: $SECRET" \
         -X POST \
         -d "{ \ 
               \"data\": { \
                 \"categorization_type\": \"personal\", \
                 \"categorization_vendor\": \"saltedge\" \
               } \
             }" \
         https://www.saltedge.com/api/v6/categorization/buckets/11111111111111/categorize
```

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

### Example Signature String

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

An example string used to generate the callback signature. It concatenates the callback_url and post_body with a vertical bar (|).

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

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

### Create Bucket - Sample Response

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

Example response from the Create Bucket endpoint, showing the bucket_id, customer_id, and status fields.

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

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

### Start Categorization - Sample response

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

Sample response from the Start Categorization endpoint, showing status 'processing' and the customer_id.

```json
{
  "data": {
    "status": "processing",
    "customer_id": 180
  }
}
```

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

### Show Consent GET - Sample Response

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

Example JSON response for a successful consent retrieval, showing consent attributes such as id, status, scopes, and timestamps.

```json
{
  "data": {
    "id": "111111111111111111",
    "connection_id": "2222222222222222222",
    "customer_id": "3333333333333333",
    "status": "active",
    "scopes": [
      "accounts",
      "transactions"
    ],
    "period_days": null,
    "expires_at": null,
    "from_date": "2021-06-14",
    "to_date": null,
    "collected_by": "saltedge",
    "revoked_at": null,
    "revoke_reason": null,
    "created_at": "2021-09-14T18:04:37Z",
    "updated_at": "2021-09-14T18:04:37Z"
  }
}
```

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

### Create Customer - Sample Response (JSON)

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

Example response from the POST /customers endpoint, showing the created customer object with email, customer_id, identifier, and timestamps.

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

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

### Sample response: VRP Consent object

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

Example JSON response for a successful GET request. Shows the VRP Consent fields including id, customer_id, provider_code, status, and consent_details.

```json
{
  "data": {
    "id": "222222222222222222",
    "customer_id": "111111111111111111",
    "provider_code": "natwest_oauth_client_gb_xf",
    "provider_name": "Natwest (Sandbox)",
    "created_at": "2026-05-06T13:24:42Z",
    "updated_at": "2026-05-06T13:24:42Z",
    "revoked_at": null,
    "status": "active",
    "consent_details": {
      "description": "Sweepco",
      "period_type": "day",
      "valid_until": "2026-07-08",
      "period_start": "consent",
      "creditor_name": "John Doe",
      "creditor_account": "50499910000998",
      "period_max_amount": 20,
      "max_one_time_amount": 5,
      "creditor_currency_code": "GBP"
    }
  }
}
```

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

### List transactions - sample response

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

Example JSON response from the GET /transactions endpoint. It contains a data array with transaction objects and a meta object with pagination information (next_id and next_page).

```json
{
  "data": [
    {
      "id": "1111111111111111111",
      "account_id": "2222222222222222222",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2024-01-03",
      "amount": 100,
      "currency_code": "EUR",
      "description": "Sample EUR for transaction on 2024-01-03",
      "category": "uncategorized",
      "extra": {
        "payee": "Sample payee",
        "payer": "Sample payer",
        "payee_information": "Sample payee information",
        "payer_information": "Sample payer information",
        "account_balance_snapshot": 1000,
        "categorization_confidence": null
      },
      "created_at": "2024-01-03T14:40:14Z",
      "updated_at": "2024-01-03T14:40:14Z"
    },
    {
      "id": "2222222222222222222",
      "account_id": "2222222222222222222",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2024-01-03",
      "amount": 100,
      "currency_code": "EUR",
      "description": "Sample EUR for transaction on 2024-01-03",
      "category": "uncategorized",
      "extra": {
        "payee": "Sample payee",
        "payer": "Sample payer",
        "payee_information": "Sample payee information",
        "payer_information": "Sample payer information",
        "account_balance_snapshot": 1000,
        "categorization_confidence": null
      },
      "created_at": "2024-01-03T14:40:14Z",
      "updated_at": "2024-01-03T14:40:14Z"
    }
  ],
  "meta": {
    "next_id": "3333333333333333333",
    "next_page": "/api/v6/transactions/?connection_id=1111111111111111111&account_id=2222222222222222222&from_id=3333333333333333333"
  }
}
```

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

### Show Customer - Sample Response (JSON)

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

Example JSON response for the Show Customer endpoint. Returns a single customer object under 'data'.

```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 Customer - Sample Response

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

Example JSON response returned after successfully creating a Customer. It includes the customer's email, customer_id, identifier, and timestamps.

```json
{
  "data": {
    "email": "email@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"
  }
}
```

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

### List consents - sample response

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

Example JSON response from the GET /api/v6/consents endpoint. Contains an array of consent objects with fields like id, connection_id, customer_id, status, scopes, and timestamps, plus a meta object with next_id and next_page for pagination.

```json
{
  "data": [
    {
      "id": "1111111111111111111",
      "connection_id": "1111111111111111111",
      "customer_id": "2222222222222222222",
      "status": "active",
      "scopes": [
        "accounts",
        "transactions"
      ],
      "period_days": null,
      "expires_at": null,
      "from_date": "2021-06-14",
      "to_date": null,
      "collected_by": "saltedge",
      "revoked_at": null,
      "revoke_reason": null,
      "created_at": "2021-09-14T18:04:37Z",
      "updated_at": "2021-09-14T18:04:37Z"
    },
    {
      "id": "2222222222222222222",
      "connection_id": "1111111111111111111",
      "customer_id": "222222222222222222",
      "status": "active",
      "scopes": [
        "accounts",
        "transactions"
      ],
      "period_days": null,
      "expires_at": null,
      "from_date": "2021-06-14",
      "to_date": null,
      "collected_by": "saltedge",
      "revoked_at": null,
      "revoke_reason": null,
      "created_at": "2021-09-14T18:04:37Z",
      "updated_at": "2021-09-14T18:04:37Z"
    }
  ],
  "meta": {
    "next_id": "3333333333333333333",
    "next_page": "/api/v6/consents?connection_id=1111111111111111111&from_id=3333333333333333333"
  }
}
```

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

### List Customers - Sample Response (JSON)

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

Example JSON response for the List Customers endpoint. Shows an array of customer objects under 'data' and pagination metadata under 'meta'.

```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 curl request for GET /providers/{provider_code}

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

Use this curl command to retrieve a Provider by its code. It includes the required App-id and Secret headers and query parameters for including AIS, PIS, and credentials fields. The example uses provider code 'fake_oauth_client_xf'.

```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/fake_oauth_client_xf?include_ais_fields=false&include_credentials_fields=false&include_pis_fields=false
```

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

### Create Customer - Sample Request (curl)

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

Use this curl command to create a new customer. It requires the APP_ID and SECRET environment variables. The request body includes customer data such as email and KYC information.

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

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

### Sample response: GET /categorization/transactions

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

Example JSON response returned by the endpoint. It contains an array of transaction objects with fields such as transaction_id, description, amount, mcc, payee, payer, type, category, extra, and made_on. The meta object includes next_id and next_page for pagination.

```json
{
  "data": [
    {
      "transaction_id": "aef5f584-a7f0-40b4-97f0-77606a4b23f3",
      "description": "lorem ipsum",
      "amount": 12.09,
      "mcc": "12495-AS",
      "payee": "some iban",
      "payee_information": "some name",
      "payer": "some iban",
      "payer_information": "some name",
      "type": "PMNT-CTRG-12",
      "category": "custom_category",
      "extra": {},
      "made_on": "2022-05-24"
    },
    {
      "transaction_id": "6925f584-41f0-40b4-81de-77606a4b23f3",
      "description": "lorem ipsum",
      "amount": -120,
      "mcc": "12725-AS",
      "payee": "some iban",
      "payee_information": "some name",
      "payer": "some iban",
      "payer_information": "some name",
      "type": "PMNT-CTFD-10",
      "extra": {},
      "made_on": "2022-05-24"
    }
  ],
  "meta": {
    "next_id": "6925f584-41f0-40b4-81de-77606a4b23f4",
    "next_page": "/api/v6/categorization/transactions?per_page=1000from_id=6925f584-41f0-40b4-81de-77606a4b23f4"
  }
}
```

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

### List Countries - Sample Request (curl)

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

Sample GET request to retrieve the list of supported countries. Uses the include_sandboxes=true query parameter. Requires App-id and Secret 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/countries?include_sandboxes=true
```

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

### GET /payments/{payment_id}

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

Retrieves details of a specific payment by its ID. This endpoint is used to get payment information.

```APIDOC
## GET /payments/{payment_id}

### Description
Retrieves details of a specific payment by its ID.

### Method
GET

### Endpoint
/payments/{payment_id}

### Parameters
#### Path Parameters
- **payment_id** (string) - Required - The ID of the payment.

### Response
#### Success Response (200)
- **data** (object) - Payment details.

#### Response Example
{
  "data": {
    "id": "payment_id",
    "status": "pending",
    "amount": 100.0,
    "currency": "EUR"
  }
}
```

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

### Show Connection - Sample Response

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

Example JSON response returned by the Show Connection endpoint. It contains the Connection object with fields such as id, status, provider_code, and last_attempt details.

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

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

### Sample request: List providers with curl

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

Use this curl command to list providers with specified query parameters. It requires the APP_ID and SECRET environment variables. The request includes filters for sandboxes, country code, and 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/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
```

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

### GET bucket - sample response

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

Sample JSON response for the GET bucket request. Contains the bucket_id, status, customer_id, and mode.

```json
{
  "data": {
    "bucket_id": "808be4c9-a4e6-41f0-81de-fd183b7347cc",
    "status": "processing",
    "customer_id": 180,
    "mode": "test"
  }
}
```
Tokens:
Raw