Create Transfer

Create a new transfer

You are advised to install safe practices and idempotencies in your codebase to prevent multiple charges. By default, Browpay secures your transfers via your unique reference.

Sample Payload

{
    "type": "bank_transfer",
    "amount": 400000,
    "currency": "NGN",
    "narration": "Test API Transfer",
    "reference": "EDonBeta4Us",
    "counterParty": {
        "nibss_code": "100015",
        "account_number": "81039283922"
    }
}

POST {{base_url}}/transfers

Fields with * are required

Headers

Name	Type	Value
Content-Type		application/json
Authorization*	String	Bearer {{your_secret_key}}

Body

Name	Type	Description
type*	String	The transfer mode this field we only allow "bank_transfer" at the moment
amount*	Integer	We expect a multiple of 100. That is, if your customer is paying 500 NGN we expect an input of 500 x 100. 50000 kobo
currency*	String	We only allow "NGN" at the moment
narration*	String	A short information about your transfer.
reference*	String	Your unique Alphanumeric reference
counterParty	Object	An object of your recipient information which consists of the nibss_code and account_number keys.
counterParty.nibss_code*	String	The receiving bank NIBSS code
counterParty.account_number*	String	The recipient's 10-digit NUBAN

Response

Always verify your transfer status via a callback or in the webhook endpoint you installed to retrieve the transfer session id. Which is defined as the transaction_id value on confirmation.

200

{
    "status": true,
    "message": "Transfer Completed",
    "data": {
        "id": "be502a67-01ac-4b30-9420-ab3d5e0023c1",
        "transaction_id": "",
        "reference": "EDonBeta4Us",
        "status": "PENDING",
        "narration": "Test API Transfer",
        "amount": 500000,
        "fee": 1075,
        "currency": "NGN",
        "created_at": "2024-12-08T20:58:44.000000Z",
        "updated_at": "2024-12-08T20:58:46.000000Z",
        "counterparty": {
            "account_name": "JOY OBAKPORO AME",
            "account_number": "81039283922",
            "nibss_code": "100015"
        }
    }
}

400

{
  "error": "Invalid request"
}