Fintract Global Developer Documentation

1. Get all banks

This endpoint retrieves a list of all registered banks.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/admin/banks

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all registered banks

bank_id:

string

name:

string

main_address:

string

currency:

string

iban:

string

swift_code:

string

country:

string

director_name:

string

secretory_name:

string

phone:

string

email:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "bank_id": "deeee965e9684ad0a86e",
      "name": "BARCLAYS BANK PLC UK",
      "main_address": "104-108 Tower Bridge Rd, London SE1 3NG, United Kingdom",
      "is_verified": true,
      "currency": "GBP",
      "iban": "GB13BUKB60161331926819",
      "swift_code": "BUKBGB22",
      "country": "GB",
      "director_name": "Matt Hammerstein",
      "secretary_name": "Nigel Higgins",
      "phone": "+443457345345",
      "email": "admin.barclays@fintractglobal.com"
  },
  {
      "bank_id": "99c72ecdbff44c3da8e7",
      "name": "HSBC",
      "main_address": "196 Oxford St, London W1D 1NT, United Kingdom",
      "is_verified": true,
      "currency": "GBP",
      "iban": "GB54HBUK60161331926819",
      "swift_code": "HBUKGB4BXXX",
      "country": "GB",
      "director_name": "Colin Bell",
      "secretary_name": "Gareth Ainsworth",
      "phone": "+443457404404",
      "email": "admin.hsbc@fintractglobal.com"
  }
]

To test the API,click here to access our testing interface.

2. Get user's all bank accounts

This endpoint retrieves the all the bank accounts associated with the authenticated customer.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array conatining details of customer's all bank accounts

Account_Holder_Fname:

string

Account_Holder_Mname:

string

Account_Holder_Lname:

string

Account_no:

string

Bank:

string

Bank_Branch:

string

account_type:

Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

id:

integer

category:

Enum:['UK','INDIA']

balance:

integer

Sample Request

Payload

No payload

Sample Response

200

application/json

[
    {
        "Account_Holder_Fname": "John",
        "Account_Holder_Mname": "",
        "Account_Holder_Lname": "Doe",
        "Account_no": "123456789098",
        "Bank": "HSBC",
        "Bank_Branch": "HSBC London",
        "account_type": "SAVINGS",
        "id": 30,
        "category": "GB",
        "balance": 20000,
        "active": true,
        "on_profile": false
    },
    {
        "Account_Holder_Fname": "John",
        "Account_Holder_Mname": "",
        "Account_Holder_Lname": "Doe",
        "Account_no": "885654321577",
        "Bank": "HSBC",
        "Bank_Branch": "HSBC London",
        "account_type": "CURRENT",
        "id": 38,
        "category": "IN",
        "balance": 0,
        "active": true,
        "on_profile": false
    }
]

To test the API,click here to access our testing interface.

3. Create bank

This endpoint is used to create a new bank account with the provided bank data. This endpoint requires authentication using a fintact admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/bank

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

name*:

string

Bank name

main_address*:

string

Main address of the bank

currency:

string

Currency

iban:

string

IBAN

swift_code:

string

Swift code

country:

string

Country name

director_name:

string

Bank's director name

phone:

string

Phone number

email:

string

Email ID

secretary_name:

string

Secretary name

Response

201 Response body schema

application/json

bank_id:

string

Bank ID

name:

string

Bank name

main_address*:

string

Main address of the bank

currency:

string

Currency

iban:

string

IBAN

swift_code:

string

Swift code

country:

string

Country name

director_name:

string

Bank's director name

phone:

string

Phone number

email:

string

Email ID

secretary_name:

string

Secretary name

is_verified:

boolean

true if bank is verified else false

Sample Request

Payload

application/json

{
  "name": "Standard Chatered",
  "main_address": "1 Basinghall Ave, London EC2V 5DD, United Kingdom",
  "currency": "GBP",
  "iban": "GB72 SCBL 6091 0412 6952 78",
  "swift_code": "SCBLGB2L",
  "country": "UK",
  "director_name": "William Thomas Winters",
  "phone": "1234567890",
  "email": "willianthomas@gmail.com",
  "secretary_name": ""
}

Sample Response

201

application/json

{
    "bank_id": "15ec4ab896a7413587571bcada5261d4",
    "name": "Standard Chatered",
    "currency": "GBP",
    "main_address": "1 Basinghall Ave, London EC2V 5DD, United Kingdom",
    "country": "UK",
    "iban": "GB72 SCBL 6091 0412 6952 78",
    "swift_code": "SCBLGB2L",
    "director_name": "William Thomas Winters",
    "secretary_name": "",
    "phone": "1234567890",
    "email": "willianthomas@gmail.com",
    "is_verified": false
}

To test the API,click here to access our testing interface.

4. Update bank

This endpoint takes bank data & updates it. This endpoint requires authentication using a fintact admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

PATCH

/bankaccounts/bank

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

bank_id*:

string

Bank ID

name*:

string

Bank name

main_address*:

string

Main address of the bank

currency:

string

Currency

iban:

string

IBAN

swift_code:

string

Swift code

country:

string

Country name

director_name:

string

Bank's director name

phone:

string

Phone number

email:

string

Email ID

secretary_name:

string

Secretary name

is_verified:

boolean

True if bank is verified

Response

200 Response body schema

application/json

bank_id:

string

Bank ID

name:

string

Bank name

main_address*:

string

Main address of the bank

currency:

string

Currency

iban:

string

IBAN

swift_code:

string

Swift code

country:

string

Country name

director_name:

string

Bank's director name

phone:

string

Phone number

email:

string

Email ID

secretary_name:

string

Secretary name

is_verified:

boolean

true if bank is verified else false

Sample Request

Payload

application/json

{
  "bank_id": "15ec4ab896a7413587571bcada5261d4",
  "name": "Standard Chatered",
  "main_address": "1 Basinghall Ave, London EC2V 5DD, United Kingdom",
  "currency": "GBP",
  "iban": "GB72 SCBL 6091 0412 6952 78",
  "swift_code": "SCBLGB2L",
  "country": "GB",
  "director_name": "William Thomas Winters",
  "secretary_name": "John Smith",
  "phone": "1234567890",
  "email": "willianthomas@gmail.com",
  "is_verified": true
}

Sample Response

201

application/json

{
  "bank_id": "15ec4ab896a7413587571bcada5261d4",
  "name": "Standard Chatered",
  "currency": "GBP",
  "main_address": "1 Basinghall Ave, London EC2V 5DD, United Kingdom",
  "country": "GB",
  "iban": "GB72 SCBL 6091 0412 6952 78",
  "swift_code": "SCBLGB2L",
  "director_name": "William Thomas Winters",
  "secretary_name": "John Smith",
  "phone": "1234567890",
  "email": "willianthomas@gmail.com",
  "is_verified": true
}

To test the API,click here to access our testing interface.

5. Verify bank

This endpoint is used to mark bank information as verified. This endpoint requires authentication using a fintract-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/verify_bank

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

name*:

string

Bank name

Response

201 Response body schema

application/json

msg:

string

Bank verified

Sample Request

Payload

application/json

{
  "name": "Standard Chatered"
}

Sample Response

201

application/json

{
  "msg": "Bank verified"
}

To test the API,click here to access our testing interface.

6. Get all bank accounts

This endpoint retrieves a list of all bank accounts.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/all

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all bank accounts

Account_Holder_Fname:

string

Account_Holder_Mname:

string

Account_Holder_Lname:

string

Account_no:

string

Bank:

string

Bank_Branch:

string

Account_type:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

id:

integer

category:

string Enum:[ UK, India ]

balance:

integer

active:

boolean

Sample Request

Payload

No payload

Sample Response

200

application/json

[
    {
        "Account_Holder_Fname": "John",
        "Account_Holder_Mname": "B",
        "Account_Holder_Lname": "Doe",
        "Account_no": "123456789181828657",
        "Bank": "HSBC",
        "Bank_Branch": "HSBC London",
        "account_type": "SAVINGS",
        "id": 19,
        "category": "GB",
        "balance": 1900,
        "active": true,
        "on_profile": false
    },
    {
        "Account_Holder_Fname": "Jordon",
        "Account_Holder_Mname": "",
        "Account_Holder_Lname": "Smith",
        "Account_no": "123212344544239725",
        "Bank": "HSBC",
        "Bank_Branch": "HSBC London",
        "account_type": "CURRENT",
        "id": 103,
        "category": "GB",
        "balance": 342427,
        "active": true,
        "on_profile": false
    },
    {
        "Account_Holder_Fname": "Ricky",
        "Account_Holder_Mname": "",
        "Account_Holder_Lname": "Scott",
        "Account_no": "46924635123456789",
        "Bank": "HSBC",
        "Bank_Branch": "HSBC London",
        "account_type": "CURRENT",
        "id": 204,
        "category": "GB",
        "balance": 1063,
        "active": true,
        "on_profile": false
    }
]

To test the API,click here to access our testing interface.

7. Get all bank-admins' bank accounts

This endpoint retrieves a list of all bank admins' bank accounts.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/bank_admin/create

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all bank-admin bank accounts

first_name:

string

middle_name:

string

last_name:

string

account_number:

string

bank_name:

string

account_type:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

id:

integer

currency:

string

balance:

integer

active:

boolean

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "first_name": "Fiona",
      "middle_name": "Rob",
      "last_name": "Rob",
      "account_number": "1234567137664744",
      "bank_name": "HSBC",
      "account_type": "CURRENT",
      "id": 51,
      "balance": 20000,
      "active": true,
      "currency": "GBP"
  },
  {
      "first_name": "Harry",
      "middle_name": "Smith",
      "last_name": "Smith",
      "account_number": "2571234555161485",
      "bank_name": "Lloyds Bank",
      "account_type": "CURRENT",
      "id": 29,
      "balance": 50000000,
      "active": true,
      "currency": "USD"
  }
]

To test the API,click here to access our testing interface.

8. Create bank account for bank-admin

This endpoint allows the creation of a bank admin account. Only users with the role FINTRACT_ADMIN can call this endpoint

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/bank_admin/create

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

first_name*:

string

First name

last_name*:

string

Last name

account_number*:

string

bank account number

bank_id*:

string

Bank ID from create bank

account_type:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

country:

string

country name

Response

201 Response body schema

application/json

msg:

string

Bank account added successfully

Sample Request

Payload

application/json

{
  "first_name":"Admin",
  "last_name":"Standard_Chartered",
  "account_number":"12346767897766",
  "bank_id":"15ec4ab896a7413587571bcada5261d4",
  "account_type":"CURRENT",
  "country":"GB"
}

Sample Response

201

application/json

{
    "msg": "Bank account added successfully"
}

To test the API,click here to access our testing interface.

9. Get bank-admin's bank accounts

This endpoint retrieves a list of all bank accounts of bank-admin.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/bank-admin/accounts

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all bank accounts of bank-admin

Account_Holder_Fname:

string

Account_Holder_Mname:

string

Account_Holder_Lname:

string

Account_no:

string

account_type:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

id:

integer

category:

string Enum:[ UK, India ]

balance:

integer

Sample Request

Payload

No payload

Sample Response

200

application/json

[
    {
        "Account_Holder_Fname": "Fiona",
        "Account_Holder_Mname": "Rob",
        "Account_Holder_Lname": "Rob",
        "Account_no": "1234567137664744",
        "account_type": "CURRENT",
        "id": 21,
        "category": "UK",
        "balance": 200000
    }
]

To test the API,click here to access our testing interface.

10. Get all bank-admins

This endpoint retrieves a list of all bank administrators. Only users with the role FINTRACT_ADMIN can call this endpoint.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/bank_admins

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all bank-admins

id:

integer

customer_id:

string

user_type:

string enum:[ CUSTOMER, BANK_ADMIN, FINTRACT_ADMIN, DEVELOPER, DEVELOPER_ADMIN ]

user_name:

string

email:

string

name:

string

admin_approved:

boolean

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "id": 39,
      "customer_id": "1234563133894860",
      "user_type": "BANK_ADMIN",
      "username": "john09",
      "email": "adminbank@fintractglobal.com",
      "name": "John Doe",
      "admin_approved": true
  },
  {
      "id": 68,
      "customer_id": "12345760544106",
      "user_type": "BANK_ADMIN",
      "username": "hsbcadmin",
      "email": "badamin.hsbc@fintractglobal.com",
      "name": "HSBC Admin",
      "admin_approved": true
  }
]

To test the API,click here to access our testing interface.

11. Admin approve bank admin

This endpoint marks a bank admin user as approved by FINTRACT_ADMIN. Only users with the role FINTRACT_ADMIN can call this endpoint.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

PATCH

/bankaccounts/bank-admin/update/{id}

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

message:

string

Updated Succesfully

Sample Request

Payload

No payload

Sample Response

200

application/json

{
  "meesage":"Updated Successfully"
  }

To test the API,click here to access our testing interface.

12. Get all customers

This endpoint retrieves a list of all customers associated with the bank. This endpoint requires authentication using a bank admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/customers

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all bank-admins

id:

integer

customer_id:

string

user_type:

string enum:[ CUSTOMER, BANK_ADMIN, FINTRACT_ADMIN, DEVELOPER, DEVELOPER_ADMIN ]

user_name:

string

email:

string

name:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "id": 50,
      "customer_id": "2211123456773",
      "user_type": "CUSTOMER",
      "username": "barrylowe",
      "email": "barrylowe@fintractglobal.com",
      "name": "Barry Lowe"
  },
  {
      "id": 98,
      "customer_id": "34021234567890",
      "user_type": "CUSTOMER",
      "username": "rickyscott",
      "email": "rickyscott@fintractglobal.com",
      "name": "Ricky Scott"
  },
  {
      "id": 67,
      "customer_id": "299123451683460",
      "user_type": "CUSTOMER",
      "username": "johnsmithuk",
      "email": "johnsmith@fintractglobal.com",
      "name": "John Smith"
  }
]

To test the API,click here to access our testing interface.

13. Get bank branches of authenticated bank-admin

This endpoint returns all the branches of a bank associated with the provided bank-admin. This endpoint requires authentication using a bank admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/bank_branch

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

array

Array of branches of the bank

Bank Name:

string

Branch Name:

string

Branch ID:

integer

IFSC:

string

Branch Address:

string

email:

string

Sort Code:

string

BIC:

string

Swift Code:

string

Country Code:

string

Contact Number:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "Bank Name": "HSBC",
      "Branch Name": "HSBC London",
      "Branch ID": 23001998367153040,
      "IFSC": "HSBC000005",
      "Branch Address": "28 Borough High St, London SE1 1YB, United Kingdom",
      "email": "badamin.hsbc@fintractglobal.com",
      "Sort Code": "40-47-82",
      "BIC": "MIDLGB22",
      "Swift Code": "MIDLGB22XXX",
      "Country Code": "GB",
      "Contact Number": "+917700900077"
  }
]

To test the API,click here to access our testing interface.

14. Get interest rates of a particular bank

This endpoint returns all interest rates associated with the provided Bank ID.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as FINTRACT_ADMIN, BANK_ADMIN or CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/interest_rate/all/{bank_id}

Request

Path Parameters

bank_id*:

string

Bank ID

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

array

Array of all ineterest rates of the bank

id:

string

name:

string

rate:

integer

bank_id:

string

bank_name:

string

country:

string

created_at:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "id": "81ce70ea501234554519296a4b64728",
      "name": "Simple",
      "rate": "2.50",
      "bank_id": "99c72ec12343da8e76115ef5457ed",
      "bank_name": "HSBC",
      "country": "GB",
      "created_at": "2023-01-19T03:21:17.636000Z"
  }
]

To test the API,click here to access our testing interface.

15. Add interest rate

This endpoint is used to add interest rate information for a bank. This endpoint requires authentication using a bank admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/interest_rate

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

name*:

string

Name

rate*:

string

Interest rate

country*:

string

Country

Response

201 Response body schema

application/json

msg:

string

Interest rate saved

Sample Request

Payload

application/json

{
  "name": "Compound",
  "rate": "6.5",
  "country": "GB"
}

Sample Response

201

application/json

[
  {
      "id": "81ce70ea501234554519296a4b64728",
      "name": "Simple",
      "rate": "2.50",
      "bank_id": "99c72ec12343da8e76115ef5457ed",
      "bank_name": "HSBC",
      "country": "GB",
      "created_at": "2023-01-19T03:21:17.636000Z"
  }
]

To test the API,click here to access our testing interface.

16. Create bank account

This endpoint is used to create a new bank account with the provided bank account data. This endpoint requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

customer_id*:

string

Customer ID

Account_Holder_Fname*:

string

First name of account holder

Account_Holder_Mname:

string

Middle name of account holder

Account_Holder_Lname:

string

Last name of account holder

Account_no*:

string

Account number

account_type*:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

category*:

string Enum:[ UK, India ]

parent_bank_branch_id*:

string

Bank ID of parent bank

interest_rate_id*:

string

Interest rate ID

Response

201 Response body schema

application/json

msg:

string

Bank account added successfully

Sample Request

Payload

application/json

{
  "customer_id": "2160123483484",
  "Account_Holder_Fname": "John",
  "Account_Holder_Mname": "B",
  "Account_Holder_Lname": "Doe",
  "Account_no": "68787798231234",
  "account_type": "CURRENT",
  "category": "UK",
  "parent_bank_branch_id": "23011234153040",
  "interest_rate_id":"81ce70ea50fb4jdvkj519296a4b64728"

}

Sample Response

201

application/json

{
  "msg": "Bank account added successfully"
}

To test the API,click here to access our testing interface.

17. Apply for card

This endpoint is used to apply for a new card by providing the account number and card details. Only customer users can call this endpoint.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/apply-card

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

card_type*:

string Enum: [Debit, Credit]

Type of card

card_provider*:

string Enum:[Visa, Master Card, Discover, American Express]

Provider of the card

account*:

string

Account number of the customer

Response

201 Response body schema

application/json

card_type:

string Enum: [Debit, Credit]

Type of card

card_provider:

string Enum:[Visa, Master Card, Discover, American Express]

Provider of the card

Sample Request

Payload

application/json

{
  "card_type": "Debit",
  "card_provider": "Master Card",
  "account":"9876543211234"
}

Sample Response

201

application/json

{
  "card_type": "Debit",
  "card_provider": "Master Card"
}

To test the API,click here to access our testing interface.

18. Get all card applications

This endpoint returns all card applications for a particular bank. Only bank-admin users can call this endpoint.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/card-applications

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

array

Array of details of all the card applications.

id:

string

card_type:

string Enum: ['Debit','Credit']

owner_name:

string

owner_id:

string

owner_email:

string

created_at:

string

id_approved:

boolean

card_provider:

string Enum:[Visa, Master Card, Discover, American Express]

Sample Request

Payload

No Payload

Sample Response

200

application/json

[
  {
      "id": "5505d74gf5447468vmhfm40953abf",
      "card_type": "Debit",
      "owner_name": "John Doe",
      "owner_id": "123456678899",
      "owner_email": "john@gmail.com",
      "created_at": "2023-06-08T03:42:08.799000Z",
      "is_approved": true,
      "card_provider": "Visa"
  },
  {
      "id": "2f2c8d012345678gfhj869d899b9cc",
      "card_type": "Debit",
      "owner_name": "John Doe",
      "owner_id": "12345678993460",
      "owner_email": "john@gmail.com",
      "created_at": "2023-07-02T08:21:29.034000Z",
      "is_approved": false,
      "card_provider": "Visa"
  }
]

To test the API,click here to access our testing interface.

19. Approve card

This endpoint approves a card request in the system. Only bank-admin users can call this endpoint.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

PATCH

/bankaccounts/approve-card/{id}

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

id*:

string

Card ID

Response

200 Response body schema

application/json

message:

string

Updated Succesfully

Sample Request

Payload

application/json

{
  "id":"875cc3e3c900485bbb3d5cbae03d3904"
}

Sample Response

200

application/json

{
  "message":"Updated Successfully"
}

To test the API,click here to access our testing interface.

20. Get user's card applications

This endpoint returns all card applications for a particular user.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/cards

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

[]:

array

Array of details of all the card applications.

id:

string

card_type:

string Enum: ['Debit','Credit']

owner_name:

string

owner_id:

string

owner_email:

string

created_at:

string

id_approved:

boolean

card_provider:

string Enum:[Visa, Master Card, Discover, American Express]

expiry_date:

string

card_number:

string

token:

string

Sample Request

Payload

No Payload

Sample Response

200

application/json

[
  {
      "id": "875cc3e3c900485bbb3d5cbae03d3904",
      "card_type": "Debit",
      "owner_name": "Divyashree",
      "owner_id": "206196230508474",
      "owner_email": "johndoe@gmail.com",
      "created_at": "2024-03-21T19:48:06.762000Z",
      "is_approved": false,
      "card_provider": "Master Card",
      "expiry_date": null,
      "card_number": "",
      "token": ""
  }
]

To test the API,click here to access our testing interface.

21. Get exchange rates

This endpoint retrieves the exchange rate of a bank. Only bank-admin users can access this endpoint. This endpoint requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/exchange

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Response

200 Response body schema

application/json

id:

string

Exchange Rates ID

bank_id:

string

Bank ID

primary_currency:

string

Primary currency of the bank

rates:

object

Object containing exchange rates

INR:

30.0

USD:

JPY:

Sample Request

Payload

No payload

Sample Response

200

application/json

{
  "id": "4b5a11234567yhfgbf7fb4ac3fd7e",
  "bank": "99c72ecdjdhvj628r769jk5ef5457ed",
  "primary_currency": "GBP",
  "rates": {
      "INR": 30.0,
      "USD": 85.0,
      "JPY": "100"
  }
}

To test the API,click here to access our testing interface.

22. Add exchange rates

This endpoint allows the addition of exchange rates for a bank by uploading a CSV file containing currency and exchange rate columns. This endpoint requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/exchange

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

multipart/form-data

csvFile*:

.csv file

A csv file containing currency and rate columns

Response

200 Response body schema

application/json

{}:

object

Object containing the exchange rates added

Sample Request

Payload

multipart/form-data

exchangeRate.csv

Sample Response

200

application/json

{
  "INR": 10.0
}

To test the API,click here to access our testing interface.

23. Update exchange rates

This endpoint is used to update the exchange rate of a bank. Only bank-admin users can access this endpoint. This endpoint requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

PATCH

/bankaccounts/exchange

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

rate*:

string

Exchange rate value

currency*:

string

Currency type

Response

200 Response body schema

application/json

id:

string

Exchange Rates ID

bank_id:

string

Bank ID

primary_currency:

string

Primary currency of the bank

rates:

object

Object containing exchange rates

INR:

30.0

USD:

JPY:

CAD:

Sample Request

Payload

application/json

{
  "rate": "60",
  "currency": "CAD"
}

Sample Response

200

application/json

{
  "id": "4b5a11234567yhfgbf7fb4ac3fd7e",
  "bank": "99c72ecdjdhvj628r769jk5ef5457ed",
  "primary_currency": "GBP",
  "rates": {
      "INR": 30.0,
      "USD": 85.0,
      "JPY": "100",
      "CAD":"60"
  }
}

To test the API,click here to access our testing interface.

24. Add payee

This endpoint allows authenticated customers to add a payee. This endpoint requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/payee

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization.

Request body schema

application/json

label*:

string

label for payee

account_number*:

string

Account number of the payee

Response

200 Response body schema

application/json

id:

string

ID

customer_id:

string

Customer ID

payees:

array

Array of all the payees with their account number

Sample Request

Payload

application/json

{
  "label": "Payee1",
  "account_number": "763765647876787"
}

Sample Response

200

application/json

{
  "id": "4118685tf635ytuyb3d2404b21fda3",
  "customer_id": "2012466348474",
  "payees": [
      {
          "label": "Payee1",
          "account_number": "763765647876787"
      }
  ]
}

To test the API,click here to access our testing interface.

25. Get all payees

This endpoint gets a list of payees of a customer. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/payee

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

id:

string

ID

customer_id:

string

Customer ID

payees:

array

Array of all the payees with their account number

Sample Request

Payload

No payload

Sample Response

200

application/json

{
  "id": "4118685tf635ytuyb3d2404b21fda3",
  "customer_id": "2012466348474",
  "payees": [
      {
          "label": "Payee1",
          "account_number": "763765647876787"
      }
  ]
}

To test the API,click here to access our testing interface.

26. Get all account creation requests

This endpoint retrieves all account creation requests of a particular bank. This requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/request/account

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

[]:

Array

Array containing details of all bank account creation requests

Account_Holder_Fname:

string

Account_Holder_Mname:

string

Account_Holder_Lname:

string

Account_no:

string

account_type:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

iban:

string

id:

integer

category:

string Enum:[ UK, India, GB ]

country:

string

active:

boolean

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "Account_Holder_Fname": "Barry",
      "Account_Holder_Mname": "",
      "Account_Holder_Lname": "Lowe",
      "Account_no": "123457853643312165",
      "account_type": "CURRENT",
      "iban": "GB96254436545634612165",
      "id": 73,
      "category": "GB",
      "country": "",
      "active": false
  },
  {
      "Account_Holder_Fname": "James",
      "Account_Holder_Mname": "",
      "Account_Holder_Lname": "Smith",
      "Account_no": "8141346465454367394",
      "account_type": "SAVINGS",
      "iban": "",
      "id": 74,
      "category": "GB",
      "country": "",
      "active": false
  }
]

To test the API,click here to access our testing interface.

27. Request for bank account

This endpoint allows users to request account creation to a bank-admin. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/request/account

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

customer_id*:

string

Customer ID

Account_Holder_Fname*:

string

First name of account holder

Account_Holder_Mname:

string

Middle name of account holder

Account_Holder_Lname*:

string

Last name of account holder

Account_no*:

string

Account number

account_type*:

string Enum:[ CURRENT, SAVINGS, PENSION, LOAN, MORTGAGE ]

category*:

string Enum:[ UK, India ]

parent_bank_branch_id*:

string

Bank ID of parent bank

Response

201 Response body schema

application/json

msg:

string

Bank account added successfully

Sample Request

Payload

application/json

{
  "customer_id": "20611234508474",
  "Account_Holder_Fname": "James",
  "Account_Holder_Mname": "",
  "Account_Holder_Lname": "Harlow",
  "Account_no": "123456789098755",
  "account_type": "CURRENT",
  "category": "UK",
  "parent_bank_branch_id": "23133346543040"
}

Sample Response

201

application/json

{
  "msg": "Bank account added successfully"
}

To test the API,click here to access our testing interface.

28. Activate bank account

This endpoint allows bank-admin to activate an account for usage by providing the account number.. This requires authentication using a bank_admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/account_activate

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

Account_no*:

string

Account number of the bank account to be activated

Response

200 Response body schema

application/json

msg:

string

Account activated

Sample Request

Payload

application/json

{
    "Account_no": "123456789098755"
}

Sample Response

200

application/json

{
  "msg": "Account activated"
}

To test the API,click here to access our testing interface.

29. Suspend bank account

This endpoint allows bank-admin to suspend an account for usage by providing the account number. This requires authentication using a bank_admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/account_suspend

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

Account_no*:

string

Account number of the bank account to be suspended

Response

200 Response body schema

application/json

msg:

string

Account suspended and removed from profile

Sample Request

Payload

application/json

{
    "Account_no": "123456789098755"
}

Sample Response

200

application/json

{
  "msg": "Account suspended and removed from profile"
}

To test the API,click here to access our testing interface.

30. Delete bank account

This endpoint allows authenticated users to delete a bank account by providing the bank account ID. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

DELETE

/bankaccounts/{bank_account_id}

Request

Path Parameters

bank_aacount_id*:

string

Bank account ID

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

msg:

string

Bank account deleted successfully

Sample Request

Payload

No payload

Sample Response

200

application/json

{
  "msg": "Bank account deleted successfully"
}

To test the API,click here to access our testing interface.

31. Get credit/debit statements

This endpoint retrieves the credit/debit statement of a bank account. This requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/statement

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

text/csv

Sample Request

Payload

No payload

Sample Response

200

text/csv

First Name,Last Name,Account Number,Account Type,Country,Credit,Debit
Barry,Lowe,249631233444552127,SAVINGS,GB,100.0,100.0
James,Smith,526431174544239725,CURRENT,GB,4161.0,4161.0
Richard,Scott,469246351234567890,CURRENT,GB,18155.0,18155.0

To test the API,click here to access our testing interface.

32. Get transaction report

This endpoint retrieves a transaction report, which includes various categories of transactions. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/transaction_report

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

Food_expense:

integer

Electricity_Expense:

integer

P2P_transfer:

integer

Self_transfer:

integer

Net_Transfer (Total excluding self transfers):

integer

Net_Received (Total received excluding self transfers):

integer

Sample Request

Payload

No payload

Sample Response

200

application/json

{
  "Food_Expense": 600,
  "Electricity_Expense": 1000,
  "P2P_Transfer": 670,
  "Self_Transfer": 0,
  "Net_Transfer (Total excluding self transfers)": 2270,
  "Net_Received (Total received excluding self transfers)": 0
}

To test the API,click here to access our testing interface.

33. Get transaction report of a bank

Retrieves the transaction report of a bank. Only bank-admin users can access this endpoint. This requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/tx-report

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

[]:

array

Array conatining details of transactions of a bank

id:

string

sender_acc:

string

receiver_acc:

string

country:

string

prediction:

string

amount:

integer

red_flag:

boolean

green_flag:

boolean

yellow_flag:

string

bank_name:

string

bank_id:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "id": "8587277b-b909-46e7-bf0f-a2b1b9786bbd",
      "sender_acc": "526431174544239725",
      "receiver_acc": "469246357415852371",
      "country": "Libya",
      "prediction": "Accept",
      "amount": 10,
      "red_flag": false,
      "green_flag": true,
      "yellow_flag": false,
      "bank_name": "HSBC",
      "bank_id": "99c72ecdbff44c3da8e76115ef5457ed"
  },
  {
      "id": "6f59b664-6f2d-40c3-a2c2-703795461467",
      "sender_acc": "526431174544239725",
      "receiver_acc": "249636347181828657",
      "country": "Libya",
      "prediction": "Accept",
      "amount": 100,
      "red_flag": false,
      "green_flag": true,
      "yellow_flag": false,
      "bank_name": "HSBC",
      "bank_id": "99c72ecdbff44c3da8e76115ef5457ed"
  },
  {
      "id": "db17ea0f-af37-401a-a23d-55d197e02175",
      "sender_acc": "526431174544239725",
      "receiver_acc": "469246357415852371",
      "country": "Libya",
      "prediction": "Accept",
      "amount": 10,
      "red_flag": false,
      "green_flag": true,
      "yellow_flag": false,
      "bank_name": "HSBC",
      "bank_id": "99c72ecdbff44c3da8e76115ef5457ed"
  }
]

To test the API,click here to access our testing interface.

34. Get all transactions of user

This endpoint retrieves all transactions of the authenticated customer. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/transactions

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

[]:

array

Array containing details of all the transaction

account:

string

to_account_no:

string

amount_send:

integer

transfer_type:

string Enum: [P2P, Food, Electricity, self, Bank_Fund, Custom]

created_at:

string

status:

string Enum: [Sent, Received, Pending, Failed]

transaction_id:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
    "account": "952446877137664744",
    "to_account_no": "123456789098",
    "amount_send": 1000,
    "transfer_type": "Bank_Fund",
    "created_at": "2024-03-18T09:53:21.552000Z",
    "status": "Received",
    "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  },
  {
    "account": "123456789098",
    "to_account_no": "35525668789879",
    "amount_send": 500,
    "transfer_type": "P2P",
    "created_at": "2024-03-18T09:54:42.590000Z",
    "status": "Failed",
    "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  },
  {
    "account": "123456789098",
    "to_account_no": "35525668789879",
    "amount_send": 500,
    "transfer_type": "P2P",
    "created_at": "2024-03-18T10:04:04.698000Z",
    "status": "Sent",
    "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  }
]

To test the API,click here to access our testing interface.

35. Get all transactions of user yearwise

This endpoint retrieves all transactions of the authenticated customer yearwise. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/transactions/{year}

Request

Path Parameters

year*:

string

Year

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

[]:

array

Array containing details of all the transaction

account:

string

to_account_no:

string

amount_send:

integer

transfer_type:

string Enum: [P2P, Food, Electricity, self, Bank_Fund, Custom]

created_at:

string

status:

string Enum: [Sent, Received, Pending, Failed]

transaction_id:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
    "account": "952446877137664744",
    "to_account_no": "123456789098",
    "amount_send": 1000,
    "transfer_type": "Bank_Fund",
    "created_at": "2024-03-18T09:53:21.552000Z",
    "status": "Received",
    "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  },
  {
    "account": "123456789098",
    "to_account_no": "35525668789879",
    "amount_send": 500,
    "transfer_type": "P2P",
    "created_at": "2024-03-18T09:54:42.590000Z",
    "status": "Failed",
    "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  },
  {
    "account": "123456789098",
    "to_account_no": "35525668789879",
    "amount_send": 500,
    "transfer_type": "P2P",
    "created_at": "2024-03-18T10:04:04.698000Z",
    "status": "Sent",
    "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  }
]

To test the API,click here to access our testing interface.

36. Transfer money

This endpoint is used to send money from one customer account to another. This requires authentication using a customer's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/transfer

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

account*:

string

Account number from which the money will be sent

to_account_no*:

string

Recipient's account number

amount_send*:

integer

Amount of money to be sent

transfer_type*:

string Enum: [P2P, Food, Electricity, self, Custom]

Type of transfer

Response

200 Response body schema

application/json

data:

object

message:

Amount Transfered Successfully

Sample Request

Payload

application/json

{
  "account": "123456789098",
  "to_account_no": "35525668789879",
  "amount_send": 500,
  "transfer_type": "P2P"
}

Sample Response

200

application/json

{
  "data": {
      "message": "Amount Transferd Successfully"
  }
}

To test the API,click here to access our testing interface.

37. Fund account

This endpoint is used to fund a particular customer account. Only Bank_Admin users can call this API. This requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/fund_account

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

account*:

string

Account number from which the money will be sent

to_account_no*:

string

Recipient's account number

amount_send*:

integer

Amount of money to be sent

type*:

string Enum: [Add]

Type of transfer

Response

200 Response body schema

application/json

data:

object

message:

Amount Transfered Successfully

Sample Request

Payload

application/json

{
  "account": "952446877137664744",
  "to_account_no": "123456789098",
  "amount_send": 1000,
  "type": "Add"
}

Sample Response

200

application/json

{
  "data": {
      "message": "Amount Transferd Successfully"
  }
}

To test the API,click here to access our testing interface.

38. Fund ledger

This endpoint facilitates the funding of a bank's ledger account. Only Fintract-admin users can call this API. This requires authentication using a fintract-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

POST

/bankaccounts/fund/ledger

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Request body schema

application/json

to_account_no*:

string

Recipient's account number

amount_send*:

integer

Amount of money to be sent

type*:

string Enum: [Add]

Type of transfer

currency:

string

Currency

Response

200 Response body schema

application/json

data:

object

message:

Amount Transfered Successfully

Sample Request

Payload

application/json

{
    "to_account_no": "123456877137664744",
    "amount_send": 100,
    "type": "Add",
    "currency": "GBP"
}

Sample Response

200

application/json

{
  "data": {
      "message": "Amount Transferd Successfully"
  }
}

To test the API,click here to access our testing interface.

39. Get ledger account transactions

This endpoint retrieves the transaction list of a bank's ledger account. This requires authentication using a bank-admin's access token.

Refer to the Authentication Guide for details on obtaining and using API keys. You can login as BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

GET

/bankaccounts/ledger/tx

Request

Header Parameters

Authorization*:

string

Bearer access token for authorization

Response

200 Response body schema

application/json

[]:

array

Array containing details of all the transaction

account:

string

to_account_no:

string

amount_send:

integer

transfer_type:

string Enum: [P2P, Add]

created_at:

string

status:

string Enum: [Sent, Received, Pending, Failed]

transaction_id:

string

Sample Request

Payload

No payload

Sample Response

200

application/json

[
  {
      "account": "0",
      "to_account_no": "123456787137664744",
      "amount_send": 100,
      "transfer_type": "P2P",
      "created_at": "2024-03-20T18:45:36.586000Z",
      "status": "Sent",
      "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  },
  {
      "account": "0",
      "to_account_no": "123456787137664744",
      "amount_send": 100,
      "transfer_type": "Add",
      "created_at": "2024-03-20T18:46:49.037000Z",
      "status": "Sent",
      "transaction_id": "b8c91796c3154a0ba1941715e00ee6ac"
  }
]

To test the API,click here to access our testing interface.

Bank Accounts

Base URL

1. Get all banks

Endpoint

Request

Header Parameters

Response

200

Response body schema

Sample Request

Sample Response

2. Get user's all bank accounts

Endpoint

Request

Header Parameters

Response

200

Response body schema

Sample Request

Sample Response

3. Create bank

Endpoint

Request

Header Parameters

Request body schema

Response

201

Response body schema

Sample Request

Sample Response

4. Update bank

Endpoint

Request

Header Parameters

Request body schema

Response

200

Response body schema

Sample Request

Sample Response

5. Verify bank

Endpoint

Request

Header Parameters

Request body schema

Response

201

Response body schema

Sample Request

Sample Response

6. Get all bank accounts

Endpoint

Request

Header Parameters

Response

200

Response body schema

Sample Request

Sample Response

7. Get all bank-admins' bank accounts

Endpoint

Request

Header Parameters

Response

200

Response body schema

Sample Request

Sample Response

8. Create bank account for bank-admin

Endpoint

Request

Header Parameters

Request body schema

Response

201

Response body schema

Sample Request

Sample Response

9. Get bank-admin's bank accounts

Endpoint