Creating a Recipient

After getting the recipient requirement and filling the required data appropriately, you can then make a request to create a recipient. An example request looks like this:

curl -i -X POST \
  https://api.busha.co/v1/recipients \
  -H 'Authorization: Bearer SDY1dHM0YklhejoxdjYzTE1QTGV0TlFMZWtLZTJpNVZuMFNFRmluUWgzUWpSZUt5bGZkUTZjNmZ1MEI=' \
  -H 'Content-Type: application/json' \
  -H 'X-BU-PROFILE-ID: BUS_YOK8tp5Zga01qOKEsqp07' \
  -d '{
    "currency_id": "NGN",
    "country_id": "NG",
    "type": "ngn_bank_transfer",
    "legal_entity_type": "business",
    "fields": [
      {
        "name": "bank_name",
        "value": "Access Bank Nigeria"
      },
      {
        "name": "account_number",
        "value": "0064244032"
      },
      {
        "name": "bank_code",
        "value": "000014"
      },
      {
        "name": "account_name",
        "value": "Joh Doe"
      }
    ]
  }'

Only NGN banks are supported at this time.

The payload of the request must match the values and validation requirements as received in recipient requirement for the same payment method.

Creating a recipient returns a response like this:

{
  "status": "success",
  "message": "message for success",
  "data": {
    "object": "recipient",
    "id": "platform_123456",
    "user_id": "platform_123456",
    "profile_id": "platform_123456",
    "currency_id": "NGN",
    "country_id": "NG",
    "type": "ngn_bank_transfer",
    "legal_entity_type": "business",
    "owned_by_customer": true,
    "active": true,
    "created_at": "2024-05-16T13:06:31.409336+01:00",
    "updated_at": "2024-05-16T13:06:31.409336+01:00",
    "fields": [
      {
        "value": "Access Bank Nigeria",
        "display_name": "Bank Name",
        "name": "bank_name",
        "is_copyable": false,
        "is_visible": true,
        "required": true
      }
    ]
  }
}

The fields’ array allow you to know how to display each field on a UI, however, the most important value after creating a recipient is the recipient id. This value will be reused in several cases especially when making a payout into that specific recipient payment account.