PAYOUT

Initiate Payout

Initiate bank transfer/payout to any banks in Nigeria

POST /v1/transfer/payout

Body

Name	Type	Description
bank_code	string	Bank Nuban code
account_number	number	Customer bank account number
account_name	string	Customer veriied account name
enquiry_token	string	Enquiry token if returned by the account name validation endpoint
amount	number	payout amount
narration	string	Payout description
reference	string	Merchant unique transaction reference

Response

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://sandbox.hitchpay.ng/v1/transfer/resolve-account',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': '••••••'
    
  },
  body: JSON.stringify({
    "bank_code": "999240",
    "account_number": "8023039719",
    "account_name": "John Doe",
    "enquiry_token": "token from resolve-account",
    "amount": 5000,
    "narration": "Business payment",
    "reference": "YOUR-UNIQUE-REF-001"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.hitchpay.ng/v1/transfer/resolve-account',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
     "bank_code": "058",
  "account_number": "0123456789",
  "account_name": "John Doe",
  "enquiry_token": "<token from resolve-account>",
  "amount": 5000,
  "narration": "Business payment",
  "reference": "YOUR-UNIQUE-REF-001"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer 82823232n2n2j3nj2n2nn23n23n'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests
import json

url = "https://sandbox.hitchpay.ng/v1/transfer/resolve-account"

payload = json.dumps({
  "bank_code": "058",
  "account_number": "0123456789",
  "account_name": "John Doe",
  "enquiry_token": "<token from resolve-account>",
  "amount": 5000,
  "narration": "Business payment",
  "reference": "YOUR-UNIQUE-REF-001"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer 82823232n2n2j3nj2n2nn23n23n'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

{
    "status": "success",
    "message": "Payout successful",
    "data": {
        "reference": "HTCHF2B9556D31D1",
        "merchant_reference": "YOUR-UNIQUE-REF-001",
        "amount": 5000,
        "fee": 30,
        "currency": "NGN",
        "account_number": "8023039719",
        "account_name": "John Doe",
        "bank_code": "999240",
        "status": "successful",
        "session_id": "999240260616175702759968021503"
    }
}

{
    "status": "error",
    "code": "INSUFFICIENT_BALANCE",
    "message": "Insufficient balance"
}

Questions? Email [email protected]. Also on GitBook.