API docs by Redocly

OneCB API Documentation (1.0)

Download OpenAPI specification:

Welcome to OneCB API Technical Documentation

DEVELOPMENT ENVIRONMENTS

SANDBOX environment serve as secure playground for developers. Use this environment to test without affecting production data.



SANDBOX url: https://api.sandbox.onecoopbank.com/gate
SWAGGER url: https://api.sandbox.onecoopbank.com/swagger

  • Purpose of Use: Develop and test applications in a controlled environment.

  • Access Credentials:

    • Navigate to Auth Service > User Login
    • Input credentials:
      • user_name: [Username]
      • password: [Password]
        • Note: We will send you the credentials through email.
    • Use session token to access endpoints by adding Bearer <token> to the Authorization header

AUTHENTICATION

(Use this documentation as guide to access all protected resources.)

One Cooperative Bank API utilizes JWT(JSON Web Token), which is commonly used for authentication and authorization in web applications and APIs.

Session Token

  • OneCB API requires session token for processing any form of API request, be it GET, POST, or PATCH.
  • This token can be generated after a successful authentication, the server creates a JWT containing a payload with information about the user and any other relevant data. This payload is typically encoded to JSON and then encoded to a string using Base64 encoding. The JWT also includes a signature to verify its authenticity.

Token Usage

  • For accessing the protected resources, client must include the JWT token in the "Authorization" header with the value Bearer <token>

Token Verification

  • When the server receives a request with a JWT, it verifies the token's signature and validity. If the signature is valid, the server processess the request.

Authorization

  • The server may also check the permissions or roles embedded in the JWT's payload to determine whether the user is authorized to access the requested resource.

Token Expiry

  • JWT tokens was set to a 30-day expiration period. Once expired, the client needs to obtain a new token by re-authenticating.

HTTP RESPONSE ERROR CODES

HTTP Status Codes

- code: 200
  label: OK
  definition: Successful Operation  
- code: 400
  label: Bad Request
  definition: Invalid Parameters        
- code: 401
  label: Unauthorized
  definition: Authentication required        
- code: 404
  label: Not Found
  definition: Resource not found          
- code: 500
  label: Internal Server Error
  definition: Server Issue

API TIMEOUT HANDLING AND IDEMPOTENCY

Idempotency is a fundamental API design principle ensuring that multiple identical API requests return the same and original response of the initial request, preventing unintentional duplicate operations. OneCB APIs are designed to be idempotent for the following reasons:

  • Resilience to Network Failures: In distributed systems, network failures, timeouts, or other transient errors can cause clients to send duplicate requests. Idempotency ensures that even if the same request is sent multiple times due to these issues, the system behaves consistently and doesn't perform the action more than once.

  • Preventing Duplicate Operations: Idempotency helps prevent unintended side effects caused by duplicate requests. For example, in an e-commerce system, if a client retries a payment request due to a timeout, idempotency ensures that the payment is processed only once, preventing double charging or other errors.

  • Consistency and Predictability: Idempotency ensures that the system behaves predictably regardless of the number of times a request is made. This consistency is crucial for maintaining data integrity and ensuring a smooth user experience.

Auth Service

Service Description This service will handle verifications of user identities and credentials. It typically serves as a gateway for users to access secured resources.

Create User

This endpoint will allow users with appropriate privileges to register new accounts within the system.

(Note: We will email you the TOKEN so that you can use this endpoint.)

Authorizations:
Bearer
Request Body schema: application/json
required
first_name
required
string

First name of the client

last_name
required
string

Last name of the client

email_address
required
string

Email address of the client

user_name
required
string

Username of the client

password
required
string

Password of the client

Responses

Request samples

Content type
application/json
{
  • "first_name": "Juan",
  • "last_name": "De La Cruz",
  • "email_address": "juan_delacruz@gmail.com",
  • "user_name": "onecb_test",
  • "password": "123456"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

User Login

This endpoint will verify user credentials.

Authorizations:
Bearer
Request Body schema: application/json
required
email_address
required
string

Email address of the client

password
required
string

Password of the client

Responses

Request samples

Content type
application/json
{
  • "email_address": "onecb_test",
  • "password": "123456"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reset Password

This endpoint enables you to securely reset your forgotten password.

Authorizations:
Bearer
Request Body schema: application/json
required
email_address
string

Email address of the client

Responses

Request samples

Content type
application/json
{
  • "email_address": "juan_delacruz@gmail.com"
}

Response samples

Content type
application/json
{
  • "status_code": 200,
  • "success": true
}

User Logout

This endpoint will allow you to terminate current session and log out of the system.

Authorizations:
Bearer
Request Body schema: application/json
required
refresh_token
string

A token used to obtain a new access token without requiring the user to re-authenticate

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwicmVmcmVzaFRva2VuIjoiZG9uYWxkX3JlZnJlc2hfdG9rZW4ifQ.d7-NxAacI4sLoU5ZRrPqU7ETTcESpgSRs6q_KoZV39A"
}

Response samples

Content type
application/json
{
  • "success": true
}

Account-As-A-Service

Service Description A service that will allow you to open OneCB bank accounts.

Retrieve Account Type List

The GetAccountTypes endpoint enables you to fetch a list of account types along with their corresponding IDs, facilitating identification and selection of specific account types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "id": "65c36a5f7f2cbf18c4d2cbfb",
  • "name": "savings account",
  • "code": "008",
  • "description": "new savings account product",
  • "created_at": "2024-02-07T11:32:47.026Z",
  • "updated_at": "2024-02-07T11:32:47.026Z",
  • "account_type": "Savings",
  • "currency": "USD",
  • "initial_deposit": "100.00",
  • "allow_debit_transaction": "true,",
  • "with_insurance": "true,",
  • "interest_computation": "string",
  • "interest_rate": {
    },
  • "minimum_adb": "string",
  • "minimum_adb_basis": "string",
  • "day_basis": true,
  • "interest_matrics": {
    },
  • "posting_frequency": "string",
  • "with_passbook": true,
  • "with_slip": true,
  • "below_maintaining_charging_active_account": {
    },
  • "below_maintaining_charging_dormant_account": {
    },
  • "dormant_charging": {
    },
  • "with_below_running_balance": {
    }
}

Retrieve Account Type Details

The GetAccountTypeDetails endpoint allows you to fetch comprehensive details about specific account types, providing essential information for a more in-depth understanding and utilization of each account type

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c36a5f7f2cbf18c4d2cbfb

Responses

Response samples

Content type
application/json
{
  • "id": "65c36a5f7f2cbf18c4d2cbfb",
  • "name": "savings account",
  • "code": "008",
  • "description": "new savings account product",
  • "created_at": "2024-02-07T11:32:47.026Z",
  • "updated_at": "2024-02-07T11:32:47.026Z",
  • "account_type": "Savings",
  • "currency": "USD",
  • "initial_deposit": "100.00",
  • "allow_debit_transaction": "true,",
  • "with_insurance": "true,",
  • "interest_computation": "string",
  • "interest_rate": {
    },
  • "minimum_adb": "string",
  • "minimum_adb_basis": "string",
  • "day_basis": true,
  • "interest_matrics": {
    },
  • "posting_frequency": "string",
  • "with_passbook": true,
  • "with_slip": true,
  • "below_maintaining_charging_active_account": {
    },
  • "below_maintaining_charging_dormant_account": {
    },
  • "dormant_charging": {
    },
  • "with_below_running_balance": {
    }
}

Retrieve Individual Customer List

The GetIndividualCustomers endpoint facilitates the retrieval of a list of individual customers, providing a comprehensive overview of their information, enabling efficient access to relevant details for further processing or analysis

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_type": "individual",
  • "name": "Juan Dela Cruz",
  • "first_name": "Juan",
  • "middle_name": "Dela",
  • "last_name": "Cruz",
  • "suffix": "jr",
  • "gender": "Male",
  • "civil_status": "Married",
  • "email_address": "test.moonshot@gmail.com",
  • "mobile_number": [
    ],
  • "photos": [
    ],
  • "signatures": [
    ],
  • "kyc": [
    ],
  • "birthday": {
    },
  • "birth_place": "Sampagar",
  • "citizenship": "Filipino",
  • "nationality": "british",
  • "tin": "11000",
  • "sss": "3333",
  • "gsis": "3333",
  • "present_address": {
    },
  • "permanent_address": {
    },
  • "father": {
    },
  • "mother": {
    },
  • "spouse": {
    },
  • "beneficiary": [
    ],
  • "employment_status": "regular",
  • "employer": {
    },
  • "bank": [
    ],
  • "created_at": "2024-02-07T02:43:07.575Z",
  • "updated_at": "2024-02-07T02:43:07.575Z"
}

Create individual Customer

The PostIndividualCustomer endpoint enables the creation of new individual customer profiles by providing the necessary details such as name, contact information, and other relevant information, facilitating the seamless addition of individual customers to the system.

Authorizations:
Bearer
header Parameters
Idempotency-Key
required
string

Idempotency key for the request

Request Body schema: application/json
required
first_name
required
string

First name of the individual customer.

customer_type
required
string

Type of customer, in this case, individual.

middle_name
string

Middle name of the individual customer.

last_name
required
string

Last name of the individual customer.

suffix
string

Suffix of the individual customer's name.

gender
required
string

Gender of the individual customer.

civil_status
required
string

Civil status of the individual customer.

email_address
required
string <email>

Email address of the individual customer.

mobile_number
required
Array of strings

Array of mobile numbers associated with the individual customer.

required
Array of objects

Array of photos associated with the individual customer.

required
Array of objects

Array of KYC (Know Your Customer) information associated with the individual customer.

signatures
required
Array of strings

Array of signature IDs associated with the individual customer.

object

Birthday of the individual customer.

birth_place
required
string

Place of birth of the individual customer.

citizenship
required
string

Citizenship of the individual customer.

nationality
required
string

Nationality of the individual customer.

tin
required
string

Tax Identification Number of the individual customer.

sss
string

SSS (Social Security System) number of the individual customer.

gsis
string

GSIS (Government Service Insurance System) number of the individual customer.

required
object

Present address of the individual customer.

required
object

Permanent address of the individual customer.

employment_status
required
string

Employment status of the individual customer.

object

Employer information associated with the individual customer.

Array of objects

Array of bank information associated with the individual customer.

object

Mother's name associated with the individual customer.

object

Father's name associated with the individual customer.

object

Spouse information associated with the individual customer.

Array of objects

Array of beneficiary information associated with the individual customer.

Responses

Request samples

Content type
application/json
{
  • "first_name": "Marsha",
  • "customer_type": "individual",
  • "middle_name": "Bug",
  • "last_name": "Mellow",
  • "suffix": "jr",
  • "gender": "Male",
  • "civil_status": "Married",
  • "email_address": "test.moonshot@gmail.com",
  • "mobile_number": [
    ],
  • "photos": [
    ],
  • "kyc": [
    ],
  • "signatures": [
    ],
  • "birthday": {
    },
  • "birth_place": "Sampagar",
  • "citizenship": "Filipino",
  • "nationality": "british",
  • "tin": "11000",
  • "sss": "3333",
  • "gsis": "3333",
  • "present_address": {
    },
  • "permanent_address": {
    },
  • "employment_status": "regular",
  • "employer": {
    },
  • "bank": [
    ],
  • "mother": {
    },
  • "father": {
    },
  • "spouse": {
    },
  • "beneficiary": [
    ]
}

Response samples

Content type
application/json
{
  • "InsertedID": "65c2cfd0db1e0711f7dfef4a"
}

Retrieve Customer Details by ID

The GetCustomerByID endpoint enables you to retrieve specific customer details by providing their unique identifier, offering a targeted and efficient way to access individual customer information

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c2ee3bdb1e0711f7dfef52

Responses

Response samples

Content type
application/json
{
  • "id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_type": "individual",
  • "name": "Ronnie Dela Cruz",
  • "first_name": "Ronnie",
  • "middle_name": "Dela",
  • "last_name": "Cruz",
  • "suffix": "jr",
  • "gender": "Male",
  • "civil_status": "Married",
  • "email_address": "test.moonshot@gmail.com",
  • "mobile_number": [
    ],
  • "photos": [
    ],
  • "signatures": [
    ],
  • "kyc": [
    ],
  • "birthday": {
    },
  • "birth_place": "Sampagar",
  • "citizenship": "Filipino",
  • "nationality": "british",
  • "tin": "11000",
  • "sss": "3333",
  • "gsis": "3333",
  • "present_address": {
    },
  • "permanent_address": {
    },
  • "father": {
    },
  • "mother": {
    },
  • "spouse": {
    },
  • "beneficiary": [
    ],
  • "employment_status": "regular",
  • "employer": {
    },
  • "bank": [
    ],
  • "created_at": "2024-02-07T02:43:07.575Z",
  • "updated_at": "2024-02-07T02:43:07.575Z"
}

Update Customer Details

The PatchAccountById endpoint enables users to update specific details of a customer account by submitting a request with the desired modifications, offering a flexible and efficient way to keep customer information up-to-date within the system

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c2ee3bdb1e0711f7dfef52
Request Body schema: application/json
required
first_name
required
string

Updated first name of the individual customer.

customer_type
required
string

Updated type of customer, in this case, individual.

middle_name
string

Updated middle name of the individual customer.

last_name
required
string

Updated last name of the individual customer.

suffix
string

Updated suffix of the individual customer's name.

gender
required
string

Updated gender of the individual customer.

civil_status
required
string

Updated civil status of the individual customer.

email_address
required
string <email>

Updated email address of the individual customer.

mobile_number
required
Array of strings

Updated array of mobile numbers associated with the individual customer.

required
Array of objects

Updated array of photos associated with the individual customer.

required
Array of objects

Updated array of KYC (Know Your Customer) information associated with the individual customer.

signatures
required
Array of strings

Updated array of signature IDs associated with the individual customer.

required
object

Updated birthday of the individual customer.

birth_place
required
string

Updated place of birth of the individual customer.

citizenship
required
string

Updated citizenship of the individual customer.

nationality
required
string

Updated nationality of the individual customer.

tin
required
string

Updated Tax Identification Number of the individual customer.

sss
string

Updated SSS (Social Security System) number of the individual customer.

gsis
string

Updated GSIS (Government Service Insurance System) number of the individual customer.

required
object

Updated present address of the individual customer.

required
object

Updated permanent address of the individual customer.

employment_status
required
string

Updated employment status of the individual customer.

object

Updated employer information associated with the individual customer.

Array of objects

Updated array of bank information associated with the individual customer.

object

Updated mother's name associated with the individual customer.

object

Updated father's name associated with the individual customer.

object

Updated spouse information associated with the individual customer.

Array of objects

Updated array of beneficiary information associated with the individual customer.

Responses

Request samples

Content type
application/json
{
  • "first_name": "Ron",
  • "customer_type": "individual",
  • "middle_name": "Pale",
  • "last_name": "Cruz",
  • "suffix": "jr",
  • "gender": "Male",
  • "civil_status": "Married",
  • "email_address": "test.moonshot@gmail.com",
  • "mobile_number": [
    ],
  • "photos": [
    ],
  • "kyc": [
    ],
  • "signatures": [
    ],
  • "birthday": {
    },
  • "birth_place": "Sampagar",
  • "citizenship": "Filipino",
  • "nationality": "british",
  • "tin": "11000",
  • "sss": "3333",
  • "gsis": "3333",
  • "present_address": {
    },
  • "permanent_address": {
    },
  • "employment_status": "regular",
  • "employer": {
    },
  • "bank": [
    ],
  • "mother": {
    },
  • "father": {
    },
  • "spouse": {
    },
  • "beneficiary": [
    ]
}

Response samples

Content type
application/json
{
  • "processed": "2024-02-07T12:00:07.059Z"
}

Delete Individual Customer

The DeleteCustomerById endpoint provides the capability to remove a customer record from the system by specifying the unique identifier associated with the customer, offering a straightforward method for deleting customer information when needed.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c2ee3bdb1e0711f7dfef52

Responses

Response samples

Content type
application/json
{
  • "message": "Account deactivated successfully!"
}

Retrieve Customer Details by Account Number

This endpoint enables you to retrieve specific customer details by providing their account number

Authorizations:
Bearer
path Parameters
account_number
required
string [ 10 .. 14 ] characters
Example: 111100010011

Responses

Response samples

Content type
application/json
{
  • "id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_type": "individual",
  • "name": "Ronnie Dela Cruz",
  • "first_name": "Ronnie",
  • "middle_name": "Dela",
  • "last_name": "Cruz",
  • "suffix": "jr",
  • "gender": "Male",
  • "civil_status": "Married",
  • "email_address": "test.moonshot@gmail.com",
  • "mobile_number": [
    ],
  • "photos": [
    ],
  • "signatures": [
    ],
  • "kyc": [
    ],
  • "birthday": {
    },
  • "birth_place": "Sampagar",
  • "citizenship": "Filipino",
  • "nationality": "british",
  • "tin": "11000",
  • "sss": "3333",
  • "gsis": "3333",
  • "present_address": {
    },
  • "permanent_address": {
    },
  • "father": {
    },
  • "mother": {
    },
  • "spouse": {
    },
  • "beneficiary": [
    ],
  • "employment_status": "regular",
  • "employer": {
    },
  • "bank": [
    ],
  • "created_at": "2024-02-07T02:43:07.575Z",
  • "updated_at": "2024-02-07T02:43:07.575Z"
}

Retrieve Institution List

The GetInstitutions endpoint facilitates the retrieval of a list of corporate customers, providing comprehensive information about each corporate customer, including their IDs, names, and other relevant details, allowing efficient access to corporate customer data for various purposes.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "id": "65c30819db1e0711f7dfef53",
  • "customer_type": "institution",
  • "name": "Juan Dela Cruz",
  • "email_address": "test.moonshot@gmail.com",
  • "photos": [
    ],
  • "kyc": [
    ],
  • "tin": "11000",
  • "business_name": "Juan Farm",
  • "trade_name": "Ones Farms",
  • "business_type": "Farm",
  • "fund_source": [
    ],
  • "phone_number": [
    ],
  • "founded_date": {
    },
  • "authorized_signatory": [
    ],
  • "dti": "12345",
  • "sec": "222222",
  • "registered_address": {
    },
  • "created_at": "2024-02-07T04:33:29.959Z",
  • "updated_at": "2024-02-07T04:33:29.959Z"
}

Create Institution

The PostInstitutionCustomer endpoint enables the creation of a new corporate customer by submitting the necessary information, such as company details, contact information, and identification data, streamlining the process of adding corporate customers to the system.

Authorizations:
Bearer
header Parameters
Idempotency-Key
required
string

Idempotency key for the request

Request Body schema: application/json
required
customer_type
required
string

Type of customer, in this case, corporate.

business_name
required
string

Name of the business associated with the corporate customer.

trade_name
string

Trade name of the business associated with the corporate customer.

business_type
required
string

Type of business associated with the corporate customer.

civil_status
string

Civil status of the corporate customer.

email_address
required
string <email>

Email address of the corporate customer.

phone_number
required
Array of strings

Array of phone numbers associated with the corporate customer.

required
object

Date when the business associated with the corporate customer was founded.

fund_source
required
Array of strings

Array of fund sources associated with the corporate customer.

required
Array of objects

Array of authorized signatories associated with the corporate customer.

tin
required
string

Tax Identification Number of the corporate customer.

sss
required
string

Social Security System (SSS) number of the corporate customer.

dti
required
string

DTI (Department of Trade and Industry) registration number.

sec
string

SEC (Securities and Exchange Commission) registration number.

required
object

Address information of the corporate customer.

required
Array of objects

Array of photos associated with the corporate customer.

Array of objects

Array of KYC (Know Your Customer) information associated with the corporate customer.

Array of objects

Array of bank information associated with the corporate customer.

Responses

Request samples

Content type
application/json
{
  • "customer_type": "institution",
  • "business_name": "Juans Farm",
  • "trade_name": "Ones Farms",
  • "business_type": "Farm",
  • "civil_status": "Married",
  • "email_address": "test.moonshot@gmail.com",
  • "phone_number": [
    ],
  • "founded_date": {
    },
  • "fund_source": [
    ],
  • "authorized_signatory": [
    ],
  • "tin": "11000",
  • "sss": "3333",
  • "dti": "12345",
  • "sec": "222222",
  • "registered_address": {
    },
  • "photos": [
    ],
  • "kyc": [
    ],
  • "bank": [
    ]
}

Response samples

Content type
application/json
{
  • "InsertedID": "65c30819db1e0711f7dfef53"
}

Retrieve Institution by ID

The GetInstitutionById endpoint facilitates the retrieval of specific customer details by providing the customer's unique identifier, offering a convenient way to access and display comprehensive information about individual customers based on their identification.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c30819db1e0711f7dfef53

Responses

Response samples

Content type
application/json
{
  • "id": "65c30819db1e0711f7dfef53",
  • "customer_type": "corporate",
  • "name": "Juans Farm",
  • "email_address": "test.moonshot@gmail.com",
  • "photos": [
    ],
  • "kyc": [
    ],
  • "tin": "11000",
  • "business_name": "Juans Farm",
  • "trade_name": "Ones Farms",
  • "business_type": "Farm",
  • "fund_source": [
    ],
  • "phone_number": [
    ],
  • "bank": [
    ],
  • "founded_date": {
    },
  • "authorized_signatory": [
    ],
  • "dti": "12345",
  • "sec": "222222",
  • "registered_address": {
    },
  • "created_at": "2024-02-07T04:33:29.959Z",
  • "updated_at": "2024-02-07T04:33:29.959Z"
}

Delete Institution

The DeleteInstitutionById endpoint facilitates the removal of a corporate customer from the system based on their unique identifier, providing a straightforward method to manage and streamline customer data.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c30819db1e0711f7dfef53

Responses

Response samples

Content type
application/json
{
  • "message": "Account deactivated successfully!"
}

Update Institution

The PatchInstitutionById endpoint empowers users to update specific details of corporate customers by providing their unique identifier, enabling seamless modification of information such as company details, contacts, and other relevant data.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c30819db1e0711f7dfef53
Request Body schema: application/json
required
customer_type
required
string

Type of customer, in this case, corporate.

name
required
string

Updated name of the corporate customer.

email_address
required
string <email>

Updated email address of the corporate customer.

tin
required
string

Updated Tax Identification Number of the corporate customer.

business_name
required
string

Updated name of the business associated with the corporate customer.

trade_name
string

Updated trade name of the business associated with the corporate customer.

business_type
required
string

Updated type of business associated with the corporate customer.

fund_source
required
Array of strings

Updated fund source associated with the corporate customer.

phone_number
required
Array of strings

Updated array of phone numbers associated with the corporate customer.

required
object

Updated date when the business associated with the corporate customer was founded.

dti
required
string

Updated DTI (Department of Trade and Industry) registration number.

sec
string

Updated SEC (Securities and Exchange Commission) registration number.

required
object

Updated address information of the corporate customer.

Responses

Request samples

Content type
application/json
{
  • "customer_type": "institution",
  • "name": "Juan Dela Cruz Farm 2",
  • "email_address": "test.moonshot@gmail.com",
  • "tin": "11000",
  • "business_name": "Juans1 Farm",
  • "trade_name": "Ones Farms",
  • "business_type": "Farm",
  • "fund_source": [
    ],
  • "phone_number": [
    ],
  • "founded_date": {
    },
  • "dti": "12345",
  • "sec": "222222",
  • "registered_address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "65c30819db1e0711f7dfef53",
  • "customer_type": "corporate",
  • "name": "Juans Farm",
  • "email_address": "test.moonshot@gmail.com",
  • "photos": [
    ],
  • "kyc": [
    ],
  • "tin": "11000",
  • "business_name": "Juans Farm",
  • "trade_name": "Ones Farms",
  • "business_type": "Farm",
  • "fund_source": [
    ],
  • "phone_number": [
    ],
  • "bank": [
    ],
  • "founded_date": {
    },
  • "authorized_signatory": [
    ],
  • "dti": "12345",
  • "sec": "222222",
  • "registered_address": {
    },
  • "created_at": "2024-02-07T04:33:29.959Z",
  • "updated_at": "2024-02-07T04:33:29.959Z"
}

Retrieve Account List

The GetAccounts endpoint empowers users to obtain a comprehensive list of accounts along with their corresponding unique identifiers, offering a convenient way to access and reference account information within the system.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "id": "65c3259e26ad14fa549242da",
  • "account_number": "111100010051",
  • "customer_id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_name": "Juan Dela Cruz",
  • "account_type_id": "65c36a5f7f2cbf18c4d2cbfb",
  • "account_description": "new savings account product",
  • "active": true,
  • "created_at": "2024-02-07T11:43:51.203Z",
  • "updated_at": "2024-02-07T11:43:51.203Z"
}

Create Account

The PostAccount endpoint facilitates the creation of a new account, enabling users to input essential details such as customer ID, account description, and account type ID

Authorizations:
Bearer
header Parameters
Idempotency-Key
required
string

Idempotency key for the request

Request Body schema: application/json
required
customer_id
required
string

Unique identifier of the customer for whom the account is being created.

account_description
string

Description or name associated with the new account.

account_type_id
required
string

Unique identifier of the account type for the new account.

Responses

Request samples

Content type
application/json
{
  • "customer_id": "65c2ee3bdb1e0711f7dfef52",
  • "account_description": "new savings account product",
  • "account_type_id": "65c36a5f7f2cbf18c4d2cbfb"
}

Response samples

Content type
application/json
{
  • "account_number": "111100010051"
}

Retrieve Account Details by Account Number

The GetAccountByNumber endpoint empowers users to retrieve detailed information about a specific account based on its account number.

Authorizations:
Bearer
path Parameters
account_number
required
string [ 10 .. 14 ] characters
Example: 111100010051

Responses

Response samples

Content type
application/json
{
  • "id": "65c3259e26ad14fa549242da",
  • "account_number": "111100010051",
  • "customer_id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_name": "Juan Dela Cruz",
  • "account_type_id": "65c36a5f7f2cbf18c4d2cbfb",
  • "account_description": "new savings account product",
  • "active": true,
  • "created_at": "2024-02-07T11:43:51.203Z",
  • "updated_at": "2024-02-07T11:43:51.203Z"
}

Retrieve Customer Accounts

The GetAccountsByCustomer endpoint facilitates the retrieval of a customer's accounts by their unique identifier, providing a comprehensive overview of the associated accounts.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c2ee3bdb1e0711f7dfef52

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Retrieve Account Details by ID

The GetAccountById endpoint empowers users to retrieve detailed information about a specific account using its unique identifier, facilitating accurate and targeted access to account-specific data.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c3259e26ad14fa549242da

Responses

Response samples

Content type
application/json
{
  • "id": "65c3259e26ad14fa549242da",
  • "account_number": "111100010051",
  • "customer_id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_name": "Juan Dela Cruz",
  • "account_type_id": "65c36a5f7f2cbf18c4d2cbfb",
  • "account_description": "new savings account product",
  • "active": true,
  • "created_at": "2024-02-07T11:43:51.203Z",
  • "updated_at": "2024-02-07T11:43:51.203Z"
}

Update Account

The PatchAccountById endpoint provides the capability to update specific account details by utilizing the account's unique identifier, ensuring a targeted and accurate modification of the account information.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c3259e26ad14fa549242da
Request Body schema: application/json
required
account_number
required
string

Unique account number associated with the account. (Note: Cannot be modified in a patch request.)

customer_id
required
string

Unique identifier of the customer who owns the account. (Note: Cannot be modified in a patch request.)

customer_name
required
string

Updated full name of the customer associated with the account.

account_type_id
required
string

Updated unique identifier of the account type associated with the account.

account_description
string

Updated description or name associated with the account.

active
boolean

Updated flag indicating whether the account is active (true) or inactive (false).

created_at
required
string <date-time>

Timestamp indicating when the account was originally created. (Note: Cannot be modified in a patch request.)

updated_at
required
string <date-time>

Timestamp indicating when the account was last updated.

Responses

Request samples

Content type
application/json
{
  • "account_number": "111100010051",
  • "customer_id": "65c2ee3bdb1e0711f7dfef52",
  • "customer_name": "Juan Dela Cruz",
  • "account_type_id": "65c36a5f7f2cbf18c4d2cbfb",
  • "account_description": "new savings account product",
  • "active": false,
  • "created_at": "2024-02-07T11:43:51.203Z",
  • "updated_at": "2024-02-07T11:43:51.203Z"
}

Response samples

Content type
application/json
{
  • "processed": "2024-01-18T08:03:01.554Z"
}

Deactivate Account

The PatchAccountById endpoint facilitates deactivation of an account by allowing updates to its status, providing a straightforward means to deactivate accounts as needed for effective account management. This feature ensures the seamless handling of account deactivation processes within the system.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c3259e26ad14fa549242da

Responses

Response samples

Content type
application/json
{
  • "message": "Account deactivated successfully!"
}

Disbursement Service

Service Description This service facilitates the transfer of funds from one account to another. It allows you to initiate and manage disbursement transactions efficiently

Endpoints & Methods

Initiating Disbursement This endpoint allows you to initiate a disbursement by providing details such as the recipients, sender and the amount to be disbursed.
Retrieving Disbursement Details This endpoint allows you to retrieve detailed information about a specific disbursement.
Retrieving List of Disbursements This endpoint allows you to retrieve list of disbursements

Get Transactions

The GetTransaction endpoint enables users to conveniently obtain a list of disbursements, offering a comprehensive view of relevant details and facilitating efficient tracking and management of disbursement transactions. This functionality supports effective financial monitoring and enhances the overall disbursement process within the system.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "id": "65c31ff7e466721f34171853",
  • "transaction_type": "FUND_TRANSFER",
  • "settlement_rail": "DIRECT",
  • "source_account_number": "1000022200022",
  • "sender": {
    },
  • "destination_account": {
    },
  • "recipient": {
    },
  • "amount": {
    },
  • "remarks": "hello world",
  • "created_at": "2024-02-07T06:15:19.543Z",
  • "updated_at": "0001-01-01T00:00:00Z"
}

Initiate Fund Transfer

The PostFundTransfer endpoint empowers users to seamlessly initiate fund transfers, providing a streamlined process for transferring funds between accounts.

Authorizations:
Bearer
header Parameters
Idempotency-Key
required
string

Idempotency key for the request

Request Body schema: application/json
required
settlement_rail
string

Settlement rail for the transaction, e.g., 'DIRECT'.

source_account_number
required
string

Account number of the source account for the transaction.

required
object
required
object
required
object
required
object
remarks
string

Additional remarks or notes associated with the transaction.

Responses

Request samples

Content type
application/json
{
  • "settlement_rail": "DIRECT",
  • "source_account_number": "1000034300022",
  • "sender": {
    },
  • "destination_account": {
    },
  • "recipient": {
    },
  • "amount": {
    },
  • "remarks": "hello world"
}

Response samples

Content type
application/json
{
  • "transaction_id": "65c3675fe466721f34171857",
  • "transaction_type": "FUND_TRANSFER",
  • "status": "SUCCESSFUL",
  • "reference_id": "5234",
  • "last_update": "2024-03-06 05:14:54.468324649 +0000 UTC m=+7216.238754568",
  • "repeat_request": false
}

Get Transaction by ID

The GetDisbursementById endpoint facilitates the retrieval of comprehensive details about a specific disbursement, offering users in-depth information such as the disbursement ID, recipient details, amount, and transaction status.

Authorizations:
Bearer
path Parameters
id
required
string = 24 characters
Example: 65c31ff7e466721f34171853

Responses

Response samples

Content type
application/json
{
  • "id": "65c31ff7e466721f34171853",
  • "transaction_type": "FUND_TRANSFER",
  • "settlement_rail": "DIRECT",
  • "source_account_number": "1000034300022",
  • "sender": {
    },
  • "destination_account": {
    },
  • "recipient": {
    },
  • "amount": {
    },
  • "remarks": "hello world",
  • "created_at": "2024-02-07T06:41:50.548Z",
  • "updated_at": "0001-01-01T00:00:00Z"
}