Overview

Pay with Transfer is a robust payment collection feature that allows businesses to receive
payments through dynamically generated account numbers. This system provides flexible
payment options tailored to business needs.

Businesses can greatly benefit from flexible payment options tailored to their needs. Here are
some key use cases:

E-commerce Platforms

These options enable e-commerce platforms to accept customer payments for product
purchases, enhancing the overall shopping experience.

Educational Institutions

Educational institutions can utilize these payment solutions to collect school fees, allowing
families the convenience of paying in instalments.

Real Estate

In the real estate sector, landlords and agents can streamline operations by effortlessly
receiving rent payments and housing deposits.


Finally, subscription services can leverage these payment options to ensure seamless
recurring billing for their customers.

  1. Flexible Dynamic Account: With this account, you can pay in instalments
    until you reach the required amount.

  2. Non-Flexible Dynamic Account: This account only receives a one-time
    payment. You must pay the exact amount that is required.

  3. Pass-Through Dynamic Account: This account allows you to receive
    payments without placing a fixed amount. The receiver receives money in
    their account through the Pass-Through account.

Body Parameters
serviceType

|

string

|

Required

Service type for this request is:
ADMIN_CREATE_DYNAMIC_COLLECTION_ACCOUNT

requestRef

|

string

|

Required

The unique reference identifier for this request.

Amount

|

integer

|

Required

Total amount the dynamic account is supposed to receive.

IsFlexiblePayment

|

boolean

Set True for a flexible account payment and False for non-flexible account payment.

This parameter is not limited to pass-through dynamic account.

RemittingAccounts

|

array object

|

Required

This should contain a list of remitter accounts.

SplitPercentage

|

integer

|

Required

The percentage split base on the number of account’s provided.

Note: Our OpenAPI is responsible for splitting the percentage based on the number of remitter accounts.

AccountNumber

|

string

|

Required

The remitter’s account number..

AccountName

|

string

The client’s account name.

IsPassThrough

|

boolean

Set True to enable account pass-through and False to disable pass-through.

This parameter is not limited to pass-through dynamic account.

Headers
Authorization : Bearer

|

string

|

Required

Your Access Token

Sample Request: Create a Flexible Dynamic Account

JSON

Copy

{
"serviceType": "ADMIN_CREATE_DYNAMIC_COLLECTION_ACCOUNT",
"requestRef": "kf594442",
"Data": {
    "Amount": 5000000,
    "IsFlexiblePayment": true,
    "AccountName": "foods",
    "RemittingAccounts": [
        {
            "SplitPercentage": 50,
            "AccountNumber": "3020806687"
        },
        {
            "SplitPercentage": 50,
            "AccountNumber": "3020808612"
        }
      ]
    }
}
Sample Request: Create a Non-Flexible Dynamic Account

JSON

Copy

{
"serviceType": "ADMIN_CREATE_DYNAMIC_COLLECTION_ACCOUNT",
"requestRef": "kf5944426",
"Data": {
    "Amount": 5000000,
    "IsFlexiblePayment": false,
    "AccountName": "foods",
    "RemittingAccounts": [
        {
            "SplitPercentage": 50,
            "AccountNumber": "3020806687"
        },
        {
            "SplitPercentage": 50,
            "AccountNumber": "3020808612"
        }
      ]
    }
}
Sample Request: Create a Pass-Through Dynamic Account

JSON

Copy

{
"serviceType": "ADMIN_CREATE_DYNAMIC_COLLECTION_ACCOUNT",
"requestRef": "kf5944426",
"Data": {
    "Amount": 5000000,
    "AccountName": "foods",
    "IsPassThrough": true,
    }
}
Response: Create Dynamic Account
{
    "message": "Request successful",
    "status": true,
    "data": {
        "accountNumber": "3020808612",
        "accountName": "foods"
    }
}
Body Parameters
serviceType

|

string

|

Required

Service type for this request is:
DYNAMIC_COLLECTION_ACCOUNT_TSQ

requestRef

|

string

|

Required

The unique reference identifier for this request.

AccountCreationRequestRef

|

string

|

Required

The request reference that was used to create a dynamic account.

AccountNumber

|

string

|

Required

The dynamic account number.

Headers
Authorization : Bearer

|

string

|

Required

Your Access Token

Sample Request: Dynamic Account TSQ

JSON

Copy

{
    "serviceType": "DYNAMIC_COLLECTION_ACCOUNT_TSQ",
    "requestRef": "23222",
    "byPassEncryption": true,
    "Data": {
        "AccountCreationRequestRef": "300-Noll",
        "AccountNumber": "7000001912"
    }
}
Response: Dynamic Account TSQ
{
    "message": "Success",
    "status": true,
    "data": {
        "totalAmountReceived": "5000.00",
        "transactionDetails": [
            {
                "amount": "5000.00",
                "transactionDate": "2023-10-13T09:16:55.1233333"
            }
        ]
    }
}

Was this page helpful?