Page Comparison

This section provides documentation for essential API calls that retrieve lists of accounts and details for individual accounts. By following these guidelines, you can effectively retrieve and utilize financial data to power your applications and services.

Panel

bgColor	#4C9AFF

Exchange Authorization Code for API Access Token

Before calling any other APIs, you must exchange the authorization code received during the user authorization process for an access token. This access token is necessary for authenticating subsequent API requests.

API Endpoint: https://api-openbanking.leatherback.co/auth/token

Method: POST

Request Headers:

Content-Type: application/x-www-form-urlencoded

Panel

bgColor	#4C9AFF

Request Body (form-encoded):

Code Block
grant_type=authorization_code&code=<authorization_code>&client_id=<client_id>&password=<password>&scope=account

Panel

bgColor	#4C9AFF

Sample Request

Code Block

curl -X POST "https://api.leatherback.com/api/v1/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=authorization_code&code=<authorization_code>&client_id=<client_id>&password=<password>&scope=account"

Panel

bgColor	#4C9AFF

Response

Code Block

language	js

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IjVEODhEQjBDMDMyMzRENjQ5NEM1NDI0ODEzRkFBQTkxIiwiY3VzdG9tZXJJZCI6IjU1ODkzNDM2LTcyY2UtNGQzYi04N2VhLTA4ZGI1YWQwNzhiYiIsImNvbnNlbnRJZCI6IjczMDkyN2U4LTY3OWMtNDlhZC05NzljLTAzMjI0YjE1MTI2MyIsIm5iZiI6MTcxOTkxNzQ2MSwiZXhwIjoxNzE5OTE3NzYxLCJpYXQiOjE3MTk5MTc0NjF9.3dPIHz9hvP4MY1u65Xb8GkkdKR6Qv0tUJZa_2tzRrWk",
    "token_type": "Bearer",
    "expires_in": 39361,
    "id_token": "oa_stg_GBjFz9x8GwZPwPpqzsQpB4nqjkCbPFFv8sQq0U4ITw0KzRzwCu",
    "access_token_id": "a8SD5zU5Dx3cXRGHz65gdyDIVeMAbUBY3ihxkjp5ZjURb6vooz"
}

Panel

bgColor	#4C9AFF

Get a List of Accounts

To retrieve a comprehensive list of accounts associated with a customer, you can use the following API call:

API Endpoint: https://api.leatherback.co/transactions/api/v1/account/get-customer-accounts

Method: GET

Path Parameters:

CustomerId: The unique identifier of the customer.

Panel

bgColor	#4C9AFF

Request Headers

Authorization: Bearer {access_token}
Content-Type: application/json

Panel

bgColor	#4C9AFF

Response

Code Block

language

...

js

{
    "value": {
        "pageData": {
            "pageNumber": 1,
            "pageCount": 1,
            "pageSize": 50,
            "hasNextPage": false,
            "hasPreviousPage": false,
            "firstItemOnPage": 1,
            "lastItemOnPage": 16,
            "totalItemCount": 16
        },
        "record": [
            
            {
                "accountId": "c3c0851b-cf46-4da2-a52b-24a221b991ca",
                "accountName": "simi Gold",
                "availableBalance": "867,940.15",
                "ledgerBalance": "864,996.25",
                "freezeRemarks": null,
                "currencyCode": "GBP",
                "currencyId": "1082ECB0-AC29-4A06-B8AD-7BC866C268AD",
                "rateByPassThresholdAmount": 10000,
                "isPrimary": false,
                "status": "Active",
                "accountExitStatus": null,
                "systemAccountType": "CustomerAccount",
                "accountDetails": [
                    {
                        "accountNumber": "GB11LEAT04069100007307",
                        "bankCountry": "United Kingdom of Great Britain and Northern Ireland",
                        "bankCountryIso": "GB",
                        "bankName": "ClearBank Ltd",
                        "bankAddress": null,
                        "paymentMethodType": "BicSwift",
                        "paymentMethodValue": "LEATGB22XXX",
                        "transitNumber": "",
                        "institutionCode": ""
                    },
                    {
                        "accountNumber": "00007307",
                        "bankCountry": "United Kingdom of Great Britain and Northern Ireland",
                        "bankCountryIso": "GB",
                        "bankName": "ClearBank Ltd",
                        "bankAddress": null,
                        "paymentMethodType": "SortCode",
                        "paymentMethodValue": "040691",
                        "transitNumber": "",
                        "institutionCode": ""
                    }
                ],
                "id": "c3c0851b-cf46-4da2-a52b-24a221b991ca",
                "dateAdded": "2023-05-22T14:53:15.2313269",
                "dateModified": "2024-06-27T08:16:25.4701998"
            },
            
        ]
    },
    "isSuccess": true,
    "error": "",
    "message": null,
    "responseCode": null
}

Panel

bgColor	#4C9AFF

Get a Single Account Details

To retrieve detailed information for a specific account, use the following API call:

API Endpoint: https://api.leatherback.co/transactions/api/v1/account/get-customer-account-detail

Method: GET

Path Parameters:

accountId: The unique identifier of the account.

Panel

bgColor	#4C9AFF

Request Headers

Authorization: Bearer {access_token}
Content-Type: application/json (if required)

Panel

bgColor	#4C9AFF

Response

Code Block

language	js

{
  "isSuccess": true,
  "error": "string",
  "message": "string",
  "responseCode": "string",
  "value": {
    "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountDetails": [
      {
        "accountNumber": "string",
        "bankCountry": "string",
        "bankCountryIso": "string",
        "bankName": "string",
        "bankAddress": "string",
        "paymentMethodType": "string",
        "paymentMethodValue": "string",
        "transitNumber": "string",
        "institutionCode": "string"
      }
    ]
  }
}

Panel

bgColor	#4C9AFF

Get a Single Account Balance

To retrieve available and ledger balance information for a specific account, use the following API call:

API Endpoint: https://api-openbanking.leatherback.co/accounts/{accountId}/balances

Method: GET

Path Parameters

accountId: The unique identifier of the account.

Panel

bgColor	#4C9AFF

Request Headers

Authorization: Bearer {access_token}
Content-Type: application/json

Panel

bgColor	#4C9AFF

Response

Code Block

language	js

{
  "Data": {
    "Balance": [
      {
        "AccountId": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditDebitIndicator": "string",
        "Type": "string",
        "DateTime": "2024-07-02T21:28:05.010Z"
      }
    ]
  },
  "Links": {
    "Self": "string"
  },
  "Meta": {
    "TotalPages": 0
  }
}

Panel

bgColor	#4C9AFF

Get a Single Account Beneficiaries

To retrieve beneficiaries information for a specific account, use the following API call:

API Endpoint: https://api-openbanking.leatherback.co/accounts/{accountId}/beneficiaries

Method: GET

Path Parameters:

accountId: The unique identifier of the account.

Panel

bgColor	#4C9AFF

Request Headers

Authorization: Bearer {access_token}
Content-Type: application/json

Panel

bgColor	#4C9AFF

Response

Code Block

language	js

{
  "Data": {
    "Account": [
      {
        "AccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "BeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "Account": [
          {
            "SchemeName": "string",
            "Identification": "string",
            "Name": "string"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "string"
  },
  "Meta": {
    "TotalPages": 0
  }
}

Previous

Next

\uD83D\uDCCB Related articles

Filter by label (Content by label)

showLabels	false
max	5
spaces	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@23bd11
sort	modified
showSpace	false
reverse	true
type	page
labels	kb-how-to-article
cql	label = "kb-how-to-article" and type = "page" and space = "LOBP"

Versions Compared

Old Version 3

New Version Current

Key

Exchange Authorization Code for API Access Token

Get a List of Accounts

Get a Single Account Details

Get a Single Account Balance

Get a Single Account Beneficiaries

\uD83D\uDCCB Related articles