List Outbound Beneficiaries
List Outbound Beneficiaries
GET {{Environment_URL}}/customers/v1/partner/legal/:cnpj/beneficiaries
This route list all outbound beneficiaries record for a client.
Headers
Name
Value
Description
Authorization
Bearer <token>
Bearer Token obtained via sign-in
Path Params
Key
Description
Required
Data Type
Example
cnpj
cnpj in format 10111101000101
true
String
10111101000101
Response
[
{
"id": "68c19e03fd4bcbb38af2899a",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+14155552671",
"cpf": "12345678901",
"currency": "USD",
"address": {
"country": "US",
"state": "NY",
"city": "New York",
"neighborhood": "Downtown",
"street": "123 Main Street",
"number": 456,
"complement": "Apt 12B",
"zipCode": "10001",
"default": true,
"nickname": "Home",
"id": "68c19e03fd4bcbb38af2899b"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "passport",
"id": "68c19e03fd4bcbb38af2899c"
}
],
"subType": "SERVICES",
"personType": "LEGAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "PASSPORT",
"value": "A1234567"
},
"bankName": "Bank of America",
"bankBranch": "001",
"bankCode": "026009593",
"bankCountry": "USA",
"bankAccountType": "CH",
"iban": "US12345678901234567890",
"number": "1234567890",
"code": {
"option": "ACH",
"value": "123456789"
},
"currency": "USD",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c19e03fd4bcbb38af2899d",
"createdAt": "2025-09-10T15:49:23.171Z"
}
},
{
"id": "68c1bf2039bc3412d26b2c30",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+14165551234",
"cpf": "98765432100",
"currency": "CAD",
"address": {
"country": "CA",
"state": "ON",
"city": "Toronto",
"neighborhood": "Financial District",
"street": "456 Queen Street",
"number": 789,
"complement": "Suite 300",
"zipCode": "M5H 2N2",
"default": true,
"nickname": "Office",
"id": "68c1bf2039bc3412d26b2c31"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "driver_license",
"id": "68c1bf2039bc3412d26b2c32"
}
],
"subType": "PERSON_TRANSFER",
"personType": "PHYSICAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "PASSPORT",
"value": "Z9876543"
},
"bankName": "Royal Bank of Canada",
"bankBranch": "12345",
"bankCode": "003",
"bankCountry": "CAN",
"bankAccountType": "CH",
"iban": "CA1234567890123456789",
"number": "123456789",
"code": {
"option": "TRANSIT",
"value": "12345"
},
"currency": "CAD",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c1bf2039bc3412d26b2c33",
"createdAt": "2025-09-10T18:10:40.210Z"
}
},
{
"id": "68c1c17c39bc3412d26b2c42",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+4915123456789",
"cpf": "98765432100",
"currency": "EUR",
"address": {
"country": "DE",
"state": "BE",
"city": "Berlin",
"neighborhood": "Mitte",
"street": "Unter den Linden",
"number": 42,
"complement": "Apt 12",
"zipCode": "10117",
"default": true,
"nickname": "Home",
"id": "68c1c17c39bc3412d26b2c43"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "passport",
"id": "68c1c17c39bc3412d26b2c44"
}
],
"subType": "PERSON_TRANSFER",
"personType": "PHYSICAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "PASSPORT",
"value": "C9876543"
},
"bankName": "Deutsche Bank",
"bankBranch": "10070000",
"bankCode": "100",
"bankCountry": "DEU",
"bankAccountType": "CH",
"iban": "DE89370400440532013000",
"code": {
"option": "SWIFT_BIC",
"value": "DEUTDEFF"
},
"currency": "EUR",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c1c17c39bc3412d26b2c45",
"createdAt": "2025-09-10T18:20:44.713Z"
}
},
{
"id": "68c1c22f39bc3412d26b2c65",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+447911123456",
"cpf": "98765432100",
"currency": "GBP",
"address": {
"country": "GB",
"state": "LN",
"city": "London",
"neighborhood": "Marylebone",
"street": "221B Baker Street",
"number": 221,
"complement": "Flat B",
"zipCode": "NW1 6XE",
"default": true,
"nickname": "London Office",
"id": "68c1c22f39bc3412d26b2c66"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "passport",
"id": "68c1c22f39bc3412d26b2c67"
}
],
"subType": "PERSON_TRANSFER",
"personType": "PHYSICAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "PASSPORT",
"value": "GB9876543"
},
"bankName": "HSBC UK",
"bankBranch": "400302",
"bankCode": "400",
"bankCountry": "GBR",
"bankAccountType": "CH",
"iban": "GB29NWBK60161331926819",
"number": "1234-5678-90",
"code": {
"option": "SORT_CODE",
"value": "123456"
},
"currency": "GBP",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c1c22f39bc3412d26b2c68",
"createdAt": "2025-09-10T18:23:43.583Z"
}
},
{
"id": "68c1c2e239bc3412d26b2c8c",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+61412345678",
"cpf": "98765432100",
"currency": "AUD",
"address": {
"country": "AU",
"state": "NSW",
"city": "Sydney",
"neighborhood": "CBD",
"street": "200 George Street",
"number": 200,
"complement": "Level 10",
"zipCode": "2000",
"default": true,
"nickname": "Sydney Office",
"id": "68c1c2e239bc3412d26b2c8d"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "passport",
"id": "68c1c2e239bc3412d26b2c8e"
}
],
"subType": "PERSON_TRANSFER",
"personType": "PHYSICAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "PASSPORT",
"value": "AU1234567"
},
"bankName": "Commonwealth Bank of Australia",
"bankBranch": "062000",
"bankCode": "062",
"bankCountry": "AUS",
"bankAccountType": "CH",
"iban": "AU123456789012345",
"number": "123456789",
"code": {
"option": "BSB_CODE",
"value": "062000"
},
"currency": "AUD",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c1c2e239bc3412d26b2c8f",
"createdAt": "2025-09-10T18:26:42.345Z"
}
},
{
"id": "68c1c47539bc3412d26b2cf4",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+541123456789",
"cpf": "98765432100",
"currency": "ARS",
"address": {
"country": "AR",
"state": "CABA",
"city": "Buenos Aires",
"neighborhood": "Centro",
"street": "Avenida Corrientes",
"number": 1234,
"complement": "Piso 7",
"zipCode": "C1043AAY",
"default": true,
"nickname": "Buenos Aires Office",
"id": "68c1c47539bc3412d26b2cf5"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "dni",
"id": "68c1c47539bc3412d26b2cf6"
}
],
"subType": "PERSON_TRANSFER",
"personType": "PHYSICAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "DNI",
"value": "12345678"
},
"bankName": "Banco de la Nación Argentina",
"bankBranch": "0001",
"bankCode": "285",
"bankCountry": "ARG",
"bankAccountType": "CH",
"number": "2850590940090418135201",
"code": {
"option": "SWIFT_BIC",
"value": "BNPAARBA"
},
"currency": "ARS",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c1c47539bc3412d26b2cf7",
"createdAt": "2025-09-10T18:33:25.261Z"
}
},
{
"id": "68c1c53839bc3412d26b2d3c",
"fullName": "{{$randomFullName}}",
"email": "{{$randomExampleEmail}}",
"phone": "+51123456789",
"cpf": "98765432100",
"currency": "PEN",
"address": {
"country": "PE",
"state": "LMA",
"city": "Lima",
"neighborhood": "Miraflores",
"street": "Avenida Larco",
"number": 890,
"complement": "Oficina 501",
"zipCode": "15074",
"default": true,
"nickname": "Lima Office",
"id": "68c1c53839bc3412d26b2d3d"
},
"type": "OUTBOUND",
"studyDocuments": [
{
"key": "dni",
"id": "68c1c53839bc3412d26b2d3e"
}
],
"subType": "PERSON_TRANSFER",
"personType": "PHYSICAL",
"account": {
"name": "{{$randomFullName}}",
"type": "OUTBOUND",
"beneficiaryDocument": {
"beneficiaryDocType": "DNI",
"value": "12345678"
},
"bankName": "Banco de Crédito del Perú",
"bankBranch": "0001",
"bankCode": "002",
"bankCountry": "PER",
"bankAccountType": "CH",
"number": "00112345678901234567",
"code": {
"option": "SWIFT_BIC",
"value": "BCPLPEPL"
},
"currency": "PEN",
"paymentMethod": "BANK_ACCOUNT",
"id": "68c1c53839bc3412d26b2d3f",
"createdAt": "2025-09-10T18:36:40.285Z"
}
}
]