Get All Beneficiaries

GET

/client-service/api/v1/beneficiaries

Request

Query Params

pageSize

integer

optional

page size - int64

pageOffset

integer

optional

page offset- int64

sortField

string

optional

field to sort by - string

sortDirection

enum<string>

optional

Allowed values:

ASCDESC

sourceBankBicOrCode

string

optional

field to input sourceBankBicOrCode - string

sourceAccountNumber

string

optional

field to input sourceAccountNumber - string

sourceCurrencyIso3Code

string

optional

field to input sourceCurrencyIso3Code - string

partnerProfileId

string

optional

field to input partnerProfileId - string

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/beneficiaries?pageSize&pageOffset&sortField&sortDirection&sourceBankBicOrCode&sourceAccountNumber&sourceCurrencyIso3Code&partnerProfileId'

Responses

🟢200OK

application/json

success response

Body

BeneficiaryOutputArray type

message

string

optional

the response message

count

number

optional

the data count

items

array[object (BeneficiaryOutput) {18}]

optional

the response data object

accountName

string

optional

The client profile UUID (optional)

accountNumber

string

optional

Account currency (required)

bankBicOrCode

string

optional

Account Name (required)

bankName

string

optional

Account country (optional)

bankAddress

string

optional

Account bankCode (optional)

name

string

optional

Account number (optional)

addressLine1

string

optional

Partner uuid (optional)

addressLine2

string

optional

Reason for the account opening (optional)

city

string

optional

Reason for the account opening (optional)

state

string

optional

Reason for the account opening (optional)

country

string

optional

Reason for the account opening (optional)

currencyIso3Code

string

optional

Reason for the account opening (optional)

emailAddress

string

optional

Reason for the account opening (optional)

phoneNumber

string

optional

Reason for the account opening (optional)

clientId

string

optional

Reason for the account opening (optional)

subClientId

string

optional

Reason for the account opening (optional)

intermediaryBank

#/components/schemas/IntermediaryBankInput

optional

the response data object

branchInformation

#/components/schemas/BranchInformationInput

optional

the response data object

Example

{
    "message": "string",
    "count": 0,
    "items": [
        {
            "accountName": "string",
            "accountNumber": "string",
            "bankBicOrCode": "string",
            "bankName": "string",
            "bankAddress": "string",
            "name": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "currencyIso3Code": "string",
            "emailAddress": "string",
            "phoneNumber": "string",
            "paymentMethod": "string",
            "clientId": "string",
            "subClientId": "string",
            "intermediaryBank": {
                "bankName": "string",
                "bic": "string",
                "country": "string"
            },
            "branchInformation": {
                "branchName": "string",
                "branchCode": "string",
                "city": "string"
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-01-29 16:40:48

Create Beneficiary

Get Beneficiary