Get Beneficiary List
Method and URL
GET [BASE_URL]/xb/beneficiary/:id
Request Params
Key
Value
showDeactivated
{{true}} → to also show deactivated beneficiaries
name
{{name}} → to filter by name
accountNumber
{{accountNumber}} → to filter by account number
countryCode
{{countryCode}} → to filter by country
Response
Response Body
{
"code": "00",
"message": "Success",
"data": [
{
"accountNumber": "12312",
"accountType": "Individual",
"address": "JL Tepok",
"bankCode": "",
"bankName": "Bank Indo",
"city": "Musselshell County",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-10-23T12:46:33Z",
"email": "",
“payoutMethod”: “WALLET”, → not yet
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Benef Name",
"postcode": "65162",
"state": "Montana",
"updatedAt": "2024-10-23T12:46:33Z",
"uuid": "f86769fe-2dc3-4a03-936b-fbedd9132ead"
},
{
"accountNumber": "Test gan",
"accountType": "Individual",
"address": "JL Tepok",
"bankCode": "",
"bankName": "Bank Indo",
"city": "Musselshell County",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-10-23T12:43:11Z",
"email": "",
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Benef Name",
"postcode": "65162",
"state": "Montana",
"updatedAt": "2024-10-23T12:45:42Z",
"uuid": "7243ea6a-04b4-4eb4-a488-2bfd83cc3d70"
},
{
"accountNumber": "22342346545133",
"accountType": "Individual",
"address": "Jalan Letkol Slamet Wardoyo 214 Labruk Lor Lumajang",
"bankCode": "545343545345354",
"bankName": "Bank of America",
"city": "Washington County",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-10-17T03:21:28Z",
"email": "",
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Rudi Susilo",
"postcode": "67312",
"state": "Alabama",
"updatedAt": "2024-10-17T03:21:28Z",
"uuid": "2969390f-725d-4fe4-90b9-76995ecf900d"
},
{
"accountNumber": "612312312312",
"accountType": "Company",
"address": "JL Tepok",
"bankCode": "4431",
"bankName": "BANK INDO",
"city": "Scobey",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-09-25T07:34:07Z",
"email": "",
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Benef Name",
"postcode": "65162",
"state": "Montana",
"updatedAt": "2024-09-25T07:34:07Z",
"uuid": "ad43a379-dcb3-4aa3-9f2c-e7a180a9abed"
},
{
"accountNumber": "92342346545151",
"accountType": "Individual",
"address": "Jalan Letkol Slamet Wardoyo 214 Labruk Lor Lumajang",
"bankCode": "545343545345356",
"bankName": "Bank of America",
"city": "New York",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-09-13T07:14:36Z",
"email": "",
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Jumarin Lur",
"postcode": "67312",
"state": "New York",
"updatedAt": "2024-09-13T07:14:36Z",
"uuid": "1549efed-c078-4e3e-ad6a-1d6ee971f6da"
},
{
"accountNumber": "1234567",
"accountType": "Individual",
"address": "Jl Street",
"bankCode": "123",
"bankName": "Bank Name",
"city": "Austin",
"contactCountryCode": "+1",
"contactNumber": "123134123",
"countryCode": "US",
"createdAt": "2024-09-13T07:07:35Z",
"email": "Halo@email.com",
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "James Chandra",
"postcode": "12345",
"state": "Texas",
"updatedAt": "2024-11-06T11:24:52Z",
"uuid": "58721a0b-c040-4083-b105-1dc5c14d6539"
},
{
"accountNumber": "82342346545151",
"accountType": "Individual",
"address": "Jalan Letkol Slamet Wardoyo 214 Labruk Lor Lumajang",
"bankCode": "545343545345356",
"bankName": "Bank of America",
"city": "Thorsby",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-09-13T07:04:51Z",
"email": "",
"identificationNumber": "",
"identificationType": "",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Muhammad Ariyanto",
"postcode": "67312",
"state": "Alabama",
"updatedAt": "2024-10-18T10:24:08Z",
"uuid": "ab092904-a4ce-418e-8d81-28564369ca3b"
},
{
"accountNumber": "62342346545150",
"accountType": "Individual",
"address": "America St.",
"bankCode": "545343545345355",
"bankName": "Bank of America",
"city": "New York",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-09-11T06:44:16Z",
"email": "",
"identificationNumber": "350810001001001",
"identificationType": "Registration ID",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Jumari",
"postcode": "12345",
"state": "New York",
"updatedAt": "2024-09-11T06:44:16Z",
"uuid": "89abf5c7-9682-491b-959b-18681637e4e8"
},
{
"accountNumber": "12342346545128",
"accountType": "Individual",
"address": "New York City, USA",
"bankCode": "545343545345354",
"bankName": "Bank of America",
"city": "New York",
"contactCountryCode": "",
"contactNumber": "",
"countryCode": "US",
"createdAt": "2024-09-04T04:20:23Z",
"email": "",
"identificationNumber": "12345678-X",
"identificationType": "Company Organization Code",
"merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
"name": "Mark Jobs",
"postcode": "10005",
"state": "New York",
"updatedAt": "2024-09-04T04:20:23Z",
"uuid": "eed31009-9cbe-4123-8e42-72549c4ca967"
}
],
"pagination": {
"page": 1,
"perPage": 50,
"totalItems": 9,
"totalPages": 1,
"fetchAll": false
}
}Last updated