API Documentation

POST/v1/payments/collection

Collections

Debit money from a mobile money wallet. Name Verify must be called before DebitMoneyService. This API is asynchronous.

Details

AuthorizationBearer API Key

Content TypeApplication/Json

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

MethodPOST

Parameters

Name	Type	Required	Description
account_name	string	Yes	Full name of the payer (from Name Verify)
account_number	string	Yes	Mobile money or bank account number
amount	float	Yes	Amount to collect (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
metadata	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 NameVerify 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	Description of transaction	No
code	Request Status code
status	Status code description		SUCCESS/FAILED
data	Information returned
msg	Gives the status of the transaction to the user		Date and time GMT

Status Codes

200Success

202Request is being processed

401Unauthorized

409Request expired

500System error

Try It

Request Body

json

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

Response Body

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