List Beneficiaries

List all beneficiaries

get

/v1/beneficiaries

Authorizations

Query parameters

searchanyOptional

Search term to filter beneficiaries by name, email, first name, or last name

limitanyOptional

Limit number

pageanyOptional

Page number

Responses

200

Beneficiaries fetched successfully

application/json

totalItemsnumberRequired

Total number of records

currentPagenumberRequired

Current page number

pageSizenumberRequired

Number of records per page

totalPagesnumberRequired

Total number of pages

get

/v1/beneficiaries

GET /v1/beneficiaries HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

Beneficiaries fetched successfully

{
  "data": [
    {
      "id": "text",
      "type": "INDIVIDUAL",
      "name": "text",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "telephone": "text",
      "externalId": "text",
      "addressLine1": "text",
      "addressLine2": "text",
      "buildingName": "text",
      "postalCode": "text",
      "city": "text",
      "country": "text",
      "state": "text",
      "businessId": "text",
      "beneficiaryAccounts": [
        {
          "id": "text",
          "bankName": "text",
          "accountName": "text",
          "accountNumber": "text",
          "country": "text",
          "swiftBic": "text",
          "routingNumber": "text",
          "iban": "text",
          "sortCode": "text",
          "currency": "NGN",
          "type": "MOBILE_MONEY",
          "settlementMethod": "ACH",
          "accountCategory": "CHECKING",
          "externalId": "text",
          "extraFields": {},
          "createdAt": "2026-03-21T04:57:03.295Z",
          "updatedAt": "2026-03-21T04:57:03.295Z"
        }
      ],
      "createdAt": "2026-03-21T04:57:03.295Z",
      "updatedAt": "2026-03-21T04:57:03.295Z"
    }
  ],
  "totalItems": 1,
  "currentPage": 1,
  "pageSize": 1,
  "totalPages": 1
}

Update beneficiary

patch

/v1/beneficiaries/{beneficiaryId}

Authorizations

Path parameters

beneficiaryIdstringRequired

Responses

200

The updated beneficiary

application/json

idstringRequired

Unique beneficiary identifier

typestring · enumRequired

Beneficiary type

Possible values:

namestringOptional

Beneficiary name (for business type)

firstNamestringOptional

First name

lastNamestringOptional

Last name

emailstringOptional

Email address

telephonestringOptional

Telephone number

externalIdstringOptional

External identifier

addressLine1stringOptional

Address line 1

addressLine2stringOptional

Address line 2

buildingNamestringOptional

Building name

postalCodestringOptional

Postal code

citystringOptional

City

countrystringOptional

Country

statestringOptional

State

businessIdstringRequired

Associated business ID

createdAtstring · date-timeRequired

Beneficiary creation timestamp

updatedAtstring · date-timeOptional

Beneficiary last update timestamp

patch

/v1/beneficiaries/{beneficiaryId}

PATCH /v1/beneficiaries/{beneficiaryId} HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

The updated beneficiary

{
  "id": "text",
  "type": "INDIVIDUAL",
  "name": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "telephone": "text",
  "externalId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "buildingName": "text",
  "postalCode": "text",
  "city": "text",
  "country": "text",
  "state": "text",
  "businessId": "text",
  "beneficiaryAccounts": [
    {
      "id": "text",
      "bankName": "text",
      "accountName": "text",
      "accountNumber": "text",
      "country": "text",
      "swiftBic": "text",
      "routingNumber": "text",
      "iban": "text",
      "sortCode": "text",
      "currency": "NGN",
      "type": "MOBILE_MONEY",
      "settlementMethod": "ACH",
      "accountCategory": "CHECKING",
      "externalId": "text",
      "extraFields": {},
      "createdAt": "2026-03-21T04:57:03.295Z",
      "updatedAt": "2026-03-21T04:57:03.295Z"
    }
  ],
  "createdAt": "2026-03-21T04:57:03.295Z",
  "updatedAt": "2026-03-21T04:57:03.295Z"
}

Delete beneficiary

delete

/v1/beneficiaries/{beneficiaryId}

Authorizations

Path parameters

beneficiaryIdstringRequired

Responses

200

Beneficiary deleted successfully

application/json

idstringRequired

Unique beneficiary identifier

typestring · enumRequired

Beneficiary type

Possible values:

namestringOptional

Beneficiary name (for business type)

firstNamestringOptional

First name

lastNamestringOptional

Last name

emailstringOptional

Email address

telephonestringOptional

Telephone number

externalIdstringOptional

External identifier

addressLine1stringOptional

Address line 1

addressLine2stringOptional

Address line 2

buildingNamestringOptional

Building name

postalCodestringOptional

Postal code

citystringOptional

City

countrystringOptional

Country

statestringOptional

State

businessIdstringRequired

Associated business ID

createdAtstring · date-timeRequired

Beneficiary creation timestamp

updatedAtstring · date-timeOptional

Beneficiary last update timestamp

delete

/v1/beneficiaries/{beneficiaryId}

DELETE /v1/beneficiaries/{beneficiaryId} HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

Beneficiary deleted successfully

{
  "id": "text",
  "type": "INDIVIDUAL",
  "name": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "telephone": "text",
  "externalId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "buildingName": "text",
  "postalCode": "text",
  "city": "text",
  "country": "text",
  "state": "text",
  "businessId": "text",
  "beneficiaryAccounts": [
    {
      "id": "text",
      "bankName": "text",
      "accountName": "text",
      "accountNumber": "text",
      "country": "text",
      "swiftBic": "text",
      "routingNumber": "text",
      "iban": "text",
      "sortCode": "text",
      "currency": "NGN",
      "type": "MOBILE_MONEY",
      "settlementMethod": "ACH",
      "accountCategory": "CHECKING",
      "externalId": "text",
      "extraFields": {},
      "createdAt": "2026-03-21T04:57:03.295Z",
      "updatedAt": "2026-03-21T04:57:03.295Z"
    }
  ],
  "createdAt": "2026-03-21T04:57:03.295Z",
  "updatedAt": "2026-03-21T04:57:03.295Z"
}

Get beneficiary accounts

get

/v1/beneficiaries/{beneficiaryId}/accounts

Authorizations

Path parameters

beneficiaryIdstringRequired

Beneficiary ID

Responses

200

List of beneficiary accounts

application/json

idstringRequired

Unique account identifier

bankNamestringOptional

Bank name

accountNamestringRequired

Account holder name

accountNumberstringOptional

Account number

countrystringOptional

Country

swiftBicstringOptional

SWIFT/BIC code

routingNumberstringOptional

Routing number

ibanstringOptional

IBAN

sortCodestringOptional

Sort code

currencystring · enumRequired

Account currency

Possible values:

typestring · enumRequired

Account type

Possible values:

settlementMethodstring · enumOptional

Settlement method

Possible values:

accountCategorystring · enumOptional

Account category

Possible values:

externalIdstringOptional

External identifier

extraFieldsobjectOptional

Extra fields

createdAtstring · date-timeRequired

Account creation timestamp

updatedAtstring · date-timeRequired

Account last update timestamp

get

/v1/beneficiaries/{beneficiaryId}/accounts

GET /v1/beneficiaries/{beneficiaryId}/accounts HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

List of beneficiary accounts

[
  {
    "id": "text",
    "bankName": "text",
    "accountName": "text",
    "accountNumber": "text",
    "country": "text",
    "swiftBic": "text",
    "routingNumber": "text",
    "iban": "text",
    "sortCode": "text",
    "currency": "NGN",
    "type": "MOBILE_MONEY",
    "settlementMethod": "ACH",
    "accountCategory": "CHECKING",
    "externalId": "text",
    "extraFields": {},
    "createdAt": "2026-03-21T04:57:03.295Z",
    "updatedAt": "2026-03-21T04:57:03.295Z"
  }
]

Add new beneficiary account

post

/v1/beneficiaries/{beneficiaryId}/accounts

Authorizations

Path parameters

beneficiaryIdstringRequired

Body

accountNumberstringRequired

The account number of the beneficiary

accountNamestringRequired

The account name of the beneficiary account

currencystring · enumRequired

The currency of the beneficiary account

Possible values:

ibanstringOptional

The IBAN of the beneficiary account

sortCodestringRequired

The sort code of the beneficiary account

swiftBicstringOptional

The SWIFT BIC of the beneficiary account

routingNumberstringOptional

The routing number of the beneficiary account

countrystringOptional

The country of the beneficiary account

bankNamestringOptional

The bank name of the beneficiary account

settlementMethodstringRequired

The settlement method of the beneficiary account

accountCategorystringOptional

The account category of the beneficiary account

Responses

200

The created beneficiary account

application/json

idstringRequired

Unique account identifier

bankNamestringOptional

Bank name

accountNamestringRequired

Account holder name

accountNumberstringOptional

Account number

countrystringOptional

Country

swiftBicstringOptional

SWIFT/BIC code

routingNumberstringOptional

Routing number

ibanstringOptional

IBAN

sortCodestringOptional

Sort code

currencystring · enumRequired

Account currency

Possible values:

typestring · enumRequired

Account type

Possible values:

settlementMethodstring · enumOptional

Settlement method

Possible values:

accountCategorystring · enumOptional

Account category

Possible values:

externalIdstringOptional

External identifier

extraFieldsobjectOptional

Extra fields

createdAtstring · date-timeRequired

Account creation timestamp

updatedAtstring · date-timeRequired

Account last update timestamp

post

/v1/beneficiaries/{beneficiaryId}/accounts

POST /v1/beneficiaries/{beneficiaryId}/accounts HTTP/1.1
Host: stage-capi.wewireafrica.com
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "accountNumber": "text",
  "accountName": "text",
  "currency": "GHS",
  "iban": "text",
  "sortCode": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "country": "text",
  "bankName": "text",
  "settlementMethod": "text",
  "accountCategory": "text"
}

200

The created beneficiary account

{
  "id": "text",
  "bankName": "text",
  "accountName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "NGN",
  "type": "MOBILE_MONEY",
  "settlementMethod": "ACH",
  "accountCategory": "CHECKING",
  "externalId": "text",
  "extraFields": {},
  "createdAt": "2026-03-21T04:57:03.295Z",
  "updatedAt": "2026-03-21T04:57:03.295Z"
}

Get beneficiary account by ID

get

/v1/beneficiaries/{beneficiaryId}/accounts/{accountId}

Authorizations

Path parameters

beneficiaryIdstringRequired

Beneficiary ID

accountIdstringRequired

Account ID

Responses

200

The beneficiary account

application/json

idstringRequired

Unique account identifier

bankNamestringOptional

Bank name

accountNamestringRequired

Account holder name

accountNumberstringOptional

Account number

countrystringOptional

Country

swiftBicstringOptional

SWIFT/BIC code

routingNumberstringOptional

Routing number

ibanstringOptional

IBAN

sortCodestringOptional

Sort code

currencystring · enumRequired

Account currency

Possible values:

typestring · enumRequired

Account type

Possible values:

settlementMethodstring · enumOptional

Settlement method

Possible values:

accountCategorystring · enumOptional

Account category

Possible values:

externalIdstringOptional

External identifier

extraFieldsobjectOptional

Extra fields

createdAtstring · date-timeRequired

Account creation timestamp

updatedAtstring · date-timeRequired

Account last update timestamp

get

/v1/beneficiaries/{beneficiaryId}/accounts/{accountId}

GET /v1/beneficiaries/{beneficiaryId}/accounts/{accountId} HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

The beneficiary account

{
  "id": "text",
  "bankName": "text",
  "accountName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "NGN",
  "type": "MOBILE_MONEY",
  "settlementMethod": "ACH",
  "accountCategory": "CHECKING",
  "externalId": "text",
  "extraFields": {},
  "createdAt": "2026-03-21T04:57:03.295Z",
  "updatedAt": "2026-03-21T04:57:03.295Z"
}

Update beneficiary account

patch

/v1/beneficiaries/{beneficiaryId}/accounts/{accountId}

Authorizations

Path parameters

accountIdstringRequired

Body

objectOptional

Responses

200

The updated beneficiary account

application/json

idstringRequired

Unique account identifier

bankNamestringOptional

Bank name

accountNamestringRequired

Account holder name

accountNumberstringOptional

Account number

countrystringOptional

Country

swiftBicstringOptional

SWIFT/BIC code

routingNumberstringOptional

Routing number

ibanstringOptional

IBAN

sortCodestringOptional

Sort code

currencystring · enumRequired

Account currency

Possible values:

typestring · enumRequired

Account type

Possible values:

settlementMethodstring · enumOptional

Settlement method

Possible values:

accountCategorystring · enumOptional

Account category

Possible values:

externalIdstringOptional

External identifier

extraFieldsobjectOptional

Extra fields

createdAtstring · date-timeRequired

Account creation timestamp

updatedAtstring · date-timeRequired

Account last update timestamp

patch

/v1/beneficiaries/{beneficiaryId}/accounts/{accountId}

PATCH /v1/beneficiaries/{beneficiaryId}/accounts/{accountId} HTTP/1.1
Host: stage-capi.wewireafrica.com
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

The updated beneficiary account

{
  "id": "text",
  "bankName": "text",
  "accountName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "NGN",
  "type": "MOBILE_MONEY",
  "settlementMethod": "ACH",
  "accountCategory": "CHECKING",
  "externalId": "text",
  "extraFields": {},
  "createdAt": "2026-03-21T04:57:03.295Z",
  "updatedAt": "2026-03-21T04:57:03.295Z"
}

Delete beneficiary account

delete

/v1/beneficiaries/accounts/{accountId}

Authorizations

Path parameters

accountIdstringRequired

Responses

200

Beneficiary account deleted successfully

application/json

idstringRequired

Unique account identifier

bankNamestringOptional

Bank name

accountNamestringRequired

Account holder name

accountNumberstringOptional

Account number

countrystringOptional

Country

swiftBicstringOptional

SWIFT/BIC code

routingNumberstringOptional

Routing number

ibanstringOptional

IBAN

sortCodestringOptional

Sort code

currencystring · enumRequired

Account currency

Possible values:

typestring · enumRequired

Account type

Possible values:

settlementMethodstring · enumOptional

Settlement method

Possible values:

accountCategorystring · enumOptional

Account category

Possible values:

externalIdstringOptional

External identifier

extraFieldsobjectOptional

Extra fields

createdAtstring · date-timeRequired

Account creation timestamp

updatedAtstring · date-timeRequired

Account last update timestamp

delete

/v1/beneficiaries/accounts/{accountId}

DELETE /v1/beneficiaries/accounts/{accountId} HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

Beneficiary account deleted successfully

{
  "id": "text",
  "bankName": "text",
  "accountName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "NGN",
  "type": "MOBILE_MONEY",
  "settlementMethod": "ACH",
  "accountCategory": "CHECKING",
  "externalId": "text",
  "extraFields": {},
  "createdAt": "2026-03-21T04:57:03.295Z",
  "updatedAt": "2026-03-21T04:57:03.295Z"
}

PreviousAdd Beneficiary Account NextGet a beneficiary

Last updated 1 month ago

hashtagList all beneficiaries

hashtagUpdate beneficiary

hashtagDelete beneficiary

hashtagGet beneficiary accounts

hashtagAdd new beneficiary account

hashtagGet beneficiary account by ID

hashtagUpdate beneficiary account

hashtagDelete beneficiary account

List all beneficiaries

Update beneficiary

Delete beneficiary

Get beneficiary accounts

Add new beneficiary account

Get beneficiary account by ID

Update beneficiary account

Delete beneficiary account