Transactions

Inter-ledger Transfers

Use this to transfer money between your accounts or to your customers ledgers

POST /accounts/transfer
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Parameters

Parameter Format Length Description
from_ledger_id
Required
string 36 The ledger from which funds are being transferred.
Acceptable Characters: a-z A-Z 0-9 –
to_ledger_id
Required
string 36 The ledger to which funds are being transferred.
Acceptable Characters: a-z A-Z 0-9 –
amount
Required
string 1-11 The amount you want to transfer.
Acceptable Characters: 0-9 .
reference
Required
string 1-18 A description of the payment that will appear on your ledger and the customer's ledger (if sending funds to one).
Acceptable Characters: a-z A-Z 0-9 _ –
{
    "from_ledger_id": "6cf0fed2-fa2c-4145-876f-38091fddcb1d",
    "to_ledger_id": "a303519e-3b65-4a1e-b8b9-b480ade983f7",
    "amount": "200",
    "reference": "Internal Transfer"
}
                                

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the response_code or error for debugging. The possible reponse codes and associated message's are as follows:

1 - success
12 - quarantined
101 - declined
650 - insufficient_funds
651 - compliance_firewall
606 - contact_support
response_code string 1-3 Numeric value to indicate the outcome of the transfer. The possible reponse codes and associated message's are as follows:

1 - success
12 - quarantined
101 - declined
650 - insufficient_funds
651 - compliance_firewall
606 - contact_support
transaction_id int 36 Unique ID we generate to identify the transaction.
{
    "status":1,
    "message":"success",
    "response_code":"1",
    "transaction_id":"22938286-283a-4594-b21c-afb1bd52d22c"
}

Process a Payout

Use this to send money to a beneficiary .

POST /account/customer/pay_out
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Parameters

Parameter Format Length Description
beneficiary_id
Required
string 36 The unique customer profile reference returned to you as part of the create_beneficiary process.
Acceptable Characters: a-z 0-9 -
reference
Required
string 1-18 A description of the payment that will appear on your ledger and the customer's ledger (if sending funds to one).
Acceptable Characters: a-z A-Z 0-9 _ –
amount
Required
string 1-11 The amount you want to payout.
Acceptable Characters: 0-9 .
{
    "beneficiary_id": "22938286-283a-4594-b21c-afb1bd52d22c",
    "reference": "Example Reference",
    "amount": "200"
}
                        

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the response_code or error for debugging. The possible reponse codes and associated message's are as follows:

1 - success
12 - quarantined
101 - declined
650 - insufficient_funds
651 - compliance_firewall
606 - contact_support
response_code string 1-3 Numeric value to indicate the outcome of the transfer. The possible reponse codes and associated message's are as follows:

1 - success
12 - quarantined
101 - declined
650 - insufficient_funds
651 - compliance_firewall
606 - contact_support
transaction_id int 36 Unique ID we generate to identify the transaction.
{
    "status":1,
    "message":"success",
    "response_code":"1",
    "transaction_id":"22938286-283a-4594-b21c-afb1bd52d22c"
 }