Single Transfer

This functionality enables you to create a virtual account on behalf of your customers. The assigned account number is unique to each customer.

Create a transfer recipient

A transfer recipient is a beneficiary on your integration that you can send money to. Before sending money to your customer, you need to collect their details first, then use their details to create a transfer recipient. We support different recipients in different countries:

The recipient_code from the data object is the unique identifier for a user and would be used to make transfers to that customer This code should be saved with the customer's records in your database.

Initiate a Transfer

When you send this request, if there are no errors, the response comes back with a pending status, while the transfer is being processed.

POST {{ BASE }}/transfer

--header 'Accept: application/json'
--header 'Authorization: Bearer {{  access_token }}'

Below are the request body parameters 🎉

Request Body

Name
Type
Description

recipient_code

String

Code for transfer recipient

account_name

String

Account Name on bank

account_number

Number

Nigerian Uniform Bank Account Number. It represents bank accounts in Nigeria.

bank_name

String

Bank Name

bank_code

String

Unique Bank Code

amount

Number

Amount to transfer

transaction_pin

String

Your Padiwise account pin

Response Body

{
    "statuscode": 200,
    "status": true,
    "message": "Transfer initiated successfully",
    "event_type": "transfer_money",
    "reference": "CUS_7ieiebfwy09k6qo",
    "data": {
        "amount": 2000,
        "charges": 12,
        "account_name": "Oluwaseun Olajuwon",
        "account_number": 1234567890,
        "bank_name": Wema Bank
        }
}

Test transfers always return success, because there is no processing involved. The live transfers processing usually take between a few seconds and a few minutes. When it's done processing, a notification is sent to your webhook URL.

Once a transfer is processed, we send the final status of the transfer as a POST request to your webhook URL.

Event
Description

transfer.success

This is sent when the transfer is successful

transfer.failed

This is sent when the transfer fails

transfer.reversed

This is sent when we refund a previously debited amount for a transfer that couldn’t be completed

The response for a transfer also contains a unique transfer code to identify this transfer. You can use this code to call the Fetch TransferAPI endpoint to get the status and details of the transfer.

Last updated