API Documentation

POST/v1/payments/disbursement

Disbursement

Credit a mobile money or bank account. This API is asynchronous.

Details

AuthorizationBearer API Key

Content TypeApplication/Json

URLhttps://360pay-merchant-api.libertepay.com/v1/payments/disbursement

MethodPOST

Parameters

Name	Type	Required	Description
account_name	string	Yes	Full name of the recipient (from Name Verify)
account_number	string	Yes	Mobile money or bank account number
amount	float	Yes	Amount to be disbursed (two decimal places)
institution_code	string	Yes	Issuer routing code
transaction_id	string	Yes	Consumer transaction ID
currency	string	Yes	Currency (default: GHS)
reference	string	No	Transaction reference
meta_data	object	No	Additional metadata

Parameters Description

Parameter	Description	isMandatory	Comment
transaction_id	Consumer transaction Id	Yes
account_number	Mobile Money or Bank Account number to receive the disbursement	Yes	Must be 12 digits for a mobile money account. EG: 233XXXXXXXXX
account_name	Full name of the recipient of disbursement	Yes	Value is retrieved from NameEnquiry API
amount	Amount to be disbursed	Yes	In two decimal places
institution_code	Issuer routing code	Yes
currency	Currency	Yes	GHS is the default value
reference	Transaction reference
status_code	Request Status code
msg	Status description
meta_data	Information returned on transaction

Status Codes

200Success

202Request is being processed

401Unauthorized

410Insufficient funds

500System error

Try It

Request Body

json

{
  "account_name": "string",
  "account_number": "string",
  "amount": float,
  "institution_code": "string",
  "transaction_id": "string",
  "currency": "string",
  "reference": "string",
  "meta_data": {
    "string": "string"
  }
}

Response Body

{
  "Code": "string",
  "data": {
    "transaction_id": "string",
    "transaction_message": "string"
  },
  "msg": "string",
  "status": "string"
}