API explorer
⁍ MatchMove Banking Operating System

Sections

API explorer

Theme switcher

Get remittance recipients list

Header Parameters

X-Auth-User-IDstring Required

MatchMove provided ID for the user.

Authorizationstring

Query Parameters

pagenumber

Page number

Default value
1
records_per_pagenumber

Number of records per page. Supported max value is 100

Default value
10
conditionstring

Getting the results based on the condition of the full match or any one match

Default value
AND
Enum values:
ANDOR
sort_orderstring

Sorting the results in order by asc or desc

Default value
DESC
Enum values:
ASCDESC
sort_fieldsstring

Sorting the results by the supported column fields

Enum values:
CREATED_AT
created_date_fromstring

Created date from. Format: YYYY-MM-DD

created_date_tostring

Created to. Format: YYYY-MM-DD

statusstring

Status of the recipient

Enum values:
CREATEDPENDINGPENDING_REVIEWPENDING_ACTIVATIONACTIVEDELETEDFAILEDBLOCKEDUPDATE_REQUIREDINACTIVE
namestring

Name of the recipient

idstring

ID of the recipient

emailstring

Email ID of the recipient

mobilestring

Mobile number of the recipient

user_idstring

User ID

countrystring

Country of recipient in ISO3166_alpha3 format

currencystring

Currency of recipient payment in ISO 4217 format

receiving_institution_typestring

Receiving institution type of payment associated with the recipient

Enum values:
BANKMOBILE_WALLETCASH_PICKUPCARDS
recipient_typestring

Type of recipient

Enum values:
INDIVIDUALBUSINESS

Response

200
Object
OK

Response Attributes

paginationobject

Show child attributes

dataarray

Show child attributes

valueobject

Show child attributes

400
Object
Bad Request | **Code** | **Title** | **Detail** | | ---------------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------| | invalid_user_id | Invalid User ID | User does not exist. Please provide a valid user id. | | invalid_query_param | Invalid Query Parameter | Invalid query parameters. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

401
Object
Unauthorized Request | **Code** | **Title** | **Detail** | | ---------------------------| ----------------------| ---------------------------------------------------| | token_required | Token Required | Access denied due to invalid token on header. | | invalid_tenant | Invalid Tenant | Access denied due to invalid tenant code. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

403
Object
Forbidden | **Code** | **Title** | **Detail** | | ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | restricted_resource | Restricted Resource | Access denied to the resource. If your access key and source IP is correct, it would be because of `X-Auth-User-ID` is not passed on header. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

404
Object
Not Found | **Code** | **Title** | **Detail** | | --------------------------| ---------------------- | -------------------------------------| | resource_not_found | Resource Not Found | The requested URL was not found. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

500
Object
Internal Server Error | **Code** | **Title** | **Detail** | | --------------------------| -----------------------| -----------------------------------------------------| | generic_error | Generic Error | General application error. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude