Account management

There are several actions you can take while managing accounts. This is done through web service calls to the platform. Below are the actions categorised under CRUD.

🗒️
Note these endpoints are POST API actions

CREATE account

The account is created first through the Create account endpoint.

READ account

You can read the following attributes in an account:

Account details via the Get account details endpoint.
Account list via the Get account list endpoint.
Account status via the Get account status endpoint.
Account balances via the Account balance list endpoint.
Account statement via the Get statement endpoint.

Contrasting the post_block and post_pend response fields of the Get statement endpoint:

post_block	post_pend
this shows the total blocked amount that has not been settled.	this shows a pending amount that applies to specific cases such as refunds and credit transactions, where the amount is not made available immediately during authorization.
Example: if the previous blocked amount is -$100 and a transaction of -$50 is received and approved, then the post_block amount will be -$150.	Example: if the previous pending amount is $100 and a refund transaction of $50 is received and approved, then the post_pend amount will be $150, which will be made available only after clearing.Note: is this feature is disabled, then post_block will be used instead.

UPDATE account

Once created, you may want to update some attributes of the account. The following is possible:

Editing an account via the Edit account endpoint.
Setting a new status to supersede the current status via the Set account status endpoint.
Setting a new default account assigned to a card via the Set default card account endpoint.
Transfering funds via the Transfer funds endpoint.
Loading or unloading an amount onto an account via the Load balance endpoint.
Either block load or unblock load functionality via the Load block unblock endpoint.
Updating individual account’s balances via the Update account balance endpoint.

Contrasting theLoad balance and Update account balance endpoints:

Load balance	Update account balance
Sample request body with required key-value pairs: `{ "api_call_unique_identifier": "001", "client_id": 12345, "input_type": "t", "input_id": 12345, "amount": 200, "amt_ccy": "404", "act_blk_pnd": "a", "cr_dr": "c" }`	Sample request body with required key-value pairs:\ `{ "client_id": 123, "api_call_unique_identifier": "001", "balance_list": [ { "input_type": "t", "input_id": 12345, "act_balance": 200, "blk_balance": 50, "bill_ccy": "404" }, { "input_type": "t", "input_id": 12346, "act_balance": 200, "blk_balance": 50, "bill_ccy": "404" } ] }`
amount:* specifies the credit/debit transaction amount performed on the account. api_call_unique_identifier: unique number that must be passed at each API request. Identifier to make each API request unique client_id:** unique identifier for the client which Paymentology will provide at the outset cr_dr:* specifies if the transaction is credit (c) or or debit (d) input_type: a -> account, t -> token. input_id:public token/account number. Pass public token when the input type ist; pass account number when the input type isa**.	actbalance and blk_balance** in the _balance_list* parameter (type: array of objects) specify what the final balance on the specified account will be act_balance:* actual balance, must be a decimal number blk_balance: blocked balance, must be a decimal number bill_ccy**: Balance Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

Load balance

Update account balance

Sample request body with required key-value pairs:

{  
    "api_call_unique_identifier": "001",  
    "client_id": 12345,  
    "input_type": "t",  
    "input_id": 12345,  
    "amount": 200,  
    "amt_ccy": "404",  
    "act_blk_pnd": "a",  
    "cr_dr": "c"  
}

Sample request body with required key-value pairs:\

{  
    "client_id": 123,  
    "api_call_unique_identifier": "001",  
    "balance_list": [  
        {  
            "input_type": "t",  
            "input_id": 12345,  
            "act_balance": 200,  
            "blk_balance": 50,  
            "bill_ccy": "404"  
        },  
        {  
            "input_type": "t",  
            "input_id": 12346,  
            "act_balance": 200,  
            "blk_balance": 50,  
            "bill_ccy": "404"  
        }  
    ]  
}

*amount:** specifies the credit/debit transaction amount performed on the account.
*api_call_unique_identifier: **unique number that must be passed at each API request. Identifier to make each API request unique
*client_id:** unique identifier for the client which Paymentology will provide at the outset
*cr_dr:** specifies if the transaction is credit (c) or or debit (d)
*input_type: **a -> account, t -> token.
*input_id:public token/account number. Pass public token when the input type ist; pass account number when the input type isa**.

*act*balance** and *blk_balance** in the _balance_list parameter (type: array of objects) specify what the final balance on the specified account will be
*act_balance:** actual balance, must be a decimal number
*blk_balance**: blocked balance, must be a decimal number
*bill_ccy**: Balance Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

Note these endpoints are POST API actions

CREATE account

READ account

UPDATE account