Add Beneficiary

Add new beneficiary

post

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/v1/beneficiaries

Authorizations

bearerww-api-key

Body

application/json

namestringOptional

The name of the beneficiary (required when type is BUSINESS)

firstNamestringOptional

The first name of the beneficiary (required when type is INDIVIDUAL)

lastNamestringOptional

The last name of the beneficiary (required when type is INDIVIDUAL)

emailstringOptional

The email of the beneficiary (required when type is not OWN_ACCOUNT)

telephonestringOptional

The telephone number of the beneficiary (required when type is not OWN_ACCOUNT)

countrystringOptional

The country of the beneficiary in ISO31661Alpha3 format (required for offshore payouts when type is not OWN_ACCOUNT)

typestringRequired

The type of the beneficiary. OWN_ACCOUNT beneficiaries are used when the payout is to be made to a wallet owned by the business. In this case, the accountDetails should contain the wallet account details. INDIVIDUAL and BUSINESS beneficiaries are used when the payout is to be made to a third party. In this case, the accountDetails should contain the bank account details of the beneficiary.

addressLine1stringOptional

The address line 1 of the beneficiary (required for offshore payouts)

addressLine2stringOptional

The address line 2 of the beneficiary (required for offshore payouts)

postalCodestringOptional

The postal code of the beneficiary (required for offshore payouts)

citystringOptional

The city of the beneficiary (required for offshore payouts)

statestringOptional

The state of the beneficiary (required for offshore payouts)

currencystringOptional

The currency of the beneficiary

Responses

200

200 response

application/json

idstringRequired

The ID of the created beneficiary

messagestringRequired

Beneficiary created successfully

post

/v1/beneficiaries

HTTPcURLJavaScriptPython

POST /v1/beneficiaries HTTP/1.1
Host: stage-capi.wewireafrica.com
Content-Type: application/json
Accept: */*
Content-Length: 467

{
  "name": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "telephone": "text",
  "country": "text",
  "type": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "postalCode": "text",
  "city": "text",
  "state": "text",
  "currency": "text",
  "accountDetails": {
    "accountNumber": "text",
    "accountName": "text",
    "currency": "GHS",
    "iban": "text",
    "sortCode": "text",
    "swiftBic": "text",
    "routingNumber": "text",
    "country": "text",
    "bankName": "text",
    "settlementMethod": "text",
    "accountCategory": "text"
  }
}

200

200 response

{
  "id": "text",
  "message": "text"
}

Create Beneficiary Example

Here's an example of how creating a beneficiary with the API would look like for an individual or business.

Business

{
    "currency": "GBP",
    "type": "BUSINESS",
    "postalCode": "19832",
    "state": "TX",
    "city": "Bravos",
    "addressLine2": "Cummin Avenue",
    "addressLine1": "80 North White Old Freeway",
    "country": "USA",
    "telephone": "[phone]",
    "email": "[email protected]",
    "name": "Wire Solutions",
    "accountDetails": {
        "bankName": "Hedwig Norman",
        "accountNumber": "257",
        "country": "USA",
        "swiftBic": "SWIFTAPD234",
        "currency": "GBP",
        "accountName": "Oleg Burns",
        "type": "BANK_ACCOUNT",
        "settlementMethod": "SWIFT",
        "iban": "ERRORQUIMOLESTIAS",
        "extraFields": {}
    }
}

Individual