Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 1.54 KB

debit.md

File metadata and controls

85 lines (57 loc) · 1.54 KB

C2B [DEBIT ACTOIN]

In other to move money from a customer's wallet to a merchant's mobile money wallet, you send debit action request.

Transactions are identified by a reference unique to the merchant.

URL : /BaseURL/BaseEndpoint/

Method : POST

Parameters

M => Mandatory O => Optional

   merchant_id (M)
   merchant_secrete (M)
   action (M)
   reference (M)
   method (M)
   amount (M)
   currency (M)
   customer_number (M)
   firstname (O)
   lastname (O)
   email (O)

Available request method :

  • orange
  • airtel
  • mpesa

Available request currencies :

  • USD
  • CDF

Request

    {
        "merchant_id": "qwertyuioiuytrew",
        "merchant_secrete": "qwertyuioiuytrew",
    	"action":"debit",
    	"reference":"asdfghjk123456890",
    	"method":"mpesa",
    	"amount":"10",
    	"currency":"CDF",
    	"customer_number":"08xxxxxxxx",
    	"firstname":"eden",
    	"lastname":"test",
    	"email":"[email protected]"
    }

Success Responses

Code : 200 OK

{
    "Status": "Success",
    "Comment": "Transaction Received Successfully",
    "Reference": "asdfghjk123456890",
    "Customer_Number": "08xxxxxxxx",
    "Amount": 10,
    "Currency": "CDF"
}

other Informations :

FreshPay tries to keep track of all customers that make transactions on their platforms: So merchants who will have to on-board their customers to the FreshPay Platform if it is a first time transactions of the customer with the FreshPay platform.