Logo Logo

Documentation v1.0

Go to Dashboard

Transaction


The Transactions API allows you create and manage payments on your integration

Initialize Transaction

Initialize a transaction from your backend

POST /transaction/initialize

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY
content-type
string 		Yes Set value to application/json 
{
  "status": true,
  "message": "Authorization URL created",
  "data": {
    "authorization_url": "https://budpay.ng/checkout/wp5goiyvc1pt",
    "access_code": "wp5goiyvc1pt",
    "reference": "REF_61e469c330c2bc"
  }
}

curl https://budpay.ng/api/v1/transaction/initialize
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{ "email": "customer@email.com", "amount": "20000","callback":"youcallbackurl" }'
-X POST

Body Param

Param Required Description
email Yes Customer email address
amount Yes Amount you are debiting customer. Do not pass this if creating subscriptions.
currency (Optional) Currency charge should be performed in. Allowed values are: NGN, USD or GBP It defaults to your integration currency. Default currency set to NGN when currency parameter is not set
ref (Optional) Unique case sensitive transaction reference. Only -,_,., =and alphanumeric characters allowed. If you do not pass this parameter, Budpay will generate a unique reference for you.
callback (Optional) Function that runs when payment is successful. This should ideally be a script that uses the verify endpoint on the Budpay API to check the status of the transaction.