Skip to main content
GET
/
api
/
v1
/
customers
/
{customerId}
/
beneficiaries
List beneficiaries for a customer
curl --request GET \
  --url http://localhost:45000/api/v1/customers/{customerId}/beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "country": "<string>",
      "companyName": "<string>",
      "address": "<string>",
      "zipCode": "<string>",
      "currencyCode": "<string>",
      "bankName": "<string>",
      "bankBic": "<string>",
      "bankCountryCode": "<string>",
      "bankAddress": "<string>",
      "accountNumber": "<string>",
      "iban": "<string>",
      "wireRoutingNumber": "<string>",
      "achRoutingNumber": "<string>",
      "intermediaryBank": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "screening": {
        "screeningSubjectId": "<string>",
        "paymentHold": true,
        "openMatchCount": 0,
        "lastScreenedAt": "<string>"
      }
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

Authorizations

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Path Parameters

customerId
string
required

Query Parameters

customerId
string
required
status
enum<string>
Available options:
PENDING_REVIEW,
CORRECTION_REQUESTED,
APPROVED,
REJECTED,
SUSPENDED
cursor
string
limit
integer
default:20
Required range: 1 <= x <= 100

Response

default - application/json
items
object[]
required
nextCursor
string | null
required
hasMore
boolean
required