Create Beneficiary

This section outlines the procedure for creating beneficiaries for transfers.

Initialization

POST /beneficiaries

Sample Request

NGN Bank Account

{
  "type": "bank_account",
  "currency": "NGN",
  "account_name": "John Doe",
  "account_number": "0123456789",
  "bank_name": "First Bank of Nigeria",
  "bank_code": "011"
}

USD Bank Account

{
  "type": "bank_account",
  "currency": "USD",
  "routing_number": "123456789",
  "rail": "ach",
  "sort_code": "123456",
  "address": {
    "line1": "15 High Road",
    "city": "New York",
    "country": "US",
    "zip_code": "10003",
    "line2": "Unit 12",
    "state": "NY"
  },
  "bank_address": {
    "line1": "20 Finance Blvd",
    "city": "Los Angeles",
    "country": "US",
    "zip_code": "90001",
    "line2": "Suite 200",
    "state": "CA"
  }
}

CAD Interac

{
  "type": "interac",
  "currency": "CAD",
  "beneficiary_type": "personal",
  "first_name": "Alice",
  "last_name": "Smith",
  "email": "[e-mail]",
  "question": "What is your pet's name?",
  "answer": "Fluffy",
  "phone_number": "1234567890"
}

Sample Response

{
  "data": {
    "account_name": "Michael Asaju",
    "account_number": "8036120312",
    "account_type": "savings",
    "address": null,
    "bank_address": null,
    "bank_code": "100004",
    "bank_id": null,
    "bank_name": "OPAY",
    "bic": null,
    "currency": "NGN",
    "id": "d71efb6e-b7f5-4acd-a729-3da08e36eaed",
    "lifetime": "permanent",
    "routing_number": null,
    "sort_code": null,
    "type": "bank_account",
    "user_id": "c545cbc5-9915-4bfb-98ee-3759894feac2",
    "virtual": false
  }
}