List Beneficiaries

List all beneficiaries

get

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

/v1/beneficiaries

Authorizations

bearerww-api-key

Responses

200

The beneficiaries

application/json

get

/v1/beneficiaries

HTTPcURLJavaScriptPython

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

200

The beneficiaries

[
  {
    "id": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "createdAt": "text",
    "updatedAt": "text"
  }
]

Update beneficiary

patch

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

/v1/beneficiaries/{beneficiaryId}

Authorizations

bearerww-api-key

Path parameters

beneficiaryIdstringRequired

Responses

200

The beneficiary

application/json

patch

/v1/beneficiaries/{beneficiaryId}

HTTPcURLJavaScriptPython

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

200

The beneficiary

{
  "id": "text",
  "name": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "telephone": "text",
  "externalId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "buildingName": "text",
  "postalCode": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "businessId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Delete beneficiary

delete

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

/v1/beneficiaries/{beneficiaryId}

Authorizations

bearerww-api-key

Path parameters

beneficiaryIdstringRequired

Responses

200

The beneficiary

application/json

delete

/v1/beneficiaries/{beneficiaryId}

HTTPcURLJavaScriptPython

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

200

The beneficiary

{
  "id": "text",
  "name": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "telephone": "text",
  "externalId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "buildingName": "text",
  "postalCode": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "businessId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Get beneficiary accounts

get

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

/v1/beneficiaries/{beneficiaryId}/accounts

Authorizations

bearerww-api-key

Path parameters

beneficiaryIdstringRequired

Beneficiary ID

Responses

200

The beneficiary accounts

application/json

get

/v1/beneficiaries/{beneficiaryId}/accounts

HTTPcURLJavaScriptPython

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

200

The beneficiary accounts

[
  {
    "id": "text",
    "bankName": "text",
    "accountNumber": "text",
    "country": "text",
    "swiftBic": "text",
    "routingNumber": "text",
    "iban": "text",
    "sortCode": "text",
    "currency": "text",
    "type": "text",
    "settlementMethod": "text",
    "accountCategory": "text",
    "extraFields": {},
    "beneficiaryId": "text",
    "createdAt": "text",
    "updatedAt": "text"
  }
]

Add new beneficiary account

post

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

/v1/beneficiaries/{beneficiaryId}/accounts

Authorizations

bearerww-api-key

Path parameters

beneficiaryIdstringRequired

Body

application/json

objectOptional

Responses

200

The beneficiary account

application/json

post

/v1/beneficiaries/{beneficiaryId}/accounts

HTTPcURLJavaScriptPython

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

{}

200

The beneficiary account

{
  "id": "text",
  "bankName": "text",
  "accountName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "text",
  "type": "text",
  "settlementMethod": "text",
  "accountCategory": "text",
  "externalId": "text",
  "extraFields": {},
  "beneficiaryId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Get beneficiary account by ID

get

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

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

Authorizations

bearerww-api-key

Path parameters

beneficiaryIdstringRequired

Beneficiary ID

accountIdstringRequired

Account ID

Responses

200

The beneficiary account

application/json

get

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

HTTPcURLJavaScriptPython

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

200

The beneficiary account

{
  "id": "text",
  "bankName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "text",
  "type": "text",
  "settlementMethod": "text",
  "accountCategory": "text",
  "extraFields": {},
  "beneficiaryId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Update beneficiary account

patch

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

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

Authorizations

bearerww-api-key

Path parameters

accountIdstringRequired

Body

application/json

objectOptional

Responses

200

The beneficiary account

application/json

patch

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

HTTPcURLJavaScriptPython

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

{}

200

The beneficiary account

{
  "id": "text",
  "bankName": "text",
  "accountName": "text",
  "accountNumber": "text",
  "country": "text",
  "swiftBic": "text",
  "routingNumber": "text",
  "iban": "text",
  "sortCode": "text",
  "currency": "text",
  "type": "text",
  "settlementMethod": "text",
  "accountCategory": "text",
  "externalId": "text",
  "extraFields": {},
  "beneficiaryId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Delete beneficiary account

delete

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

/v1/beneficiaries/accounts/{accountId}

Authorizations

bearerww-api-key

Path parameters

accountIdstringRequired

Responses

200

The beneficiary account

application/json

delete

/v1/beneficiaries/accounts/{accountId}

HTTPcURLJavaScriptPython

DELETE /v1/beneficiaries/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": "text",
  "type": "text",
  "settlementMethod": "text",
  "accountCategory": "text",
  "externalId": "text",
  "extraFields": {},
  "beneficiaryId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}