API explorer
⁍ MatchMove Banking Operating System

Sections

API explorer

Theme switcher

Get oauth remittance recipient details

Header Parameters

Authorizationstring

Path Parameters

idstring Required

ID of the recipient

Response

200
Object
OK

Response Attributes

idstring

ID of the recipient

receiving_institution_typestring Required

Receiving institution type of payment associated with the recipient.

Enum values:
BANKMOBILE_WALLETCASH_PICKUPCARDS
recipient_typestring Required

Type of recipient

Enum values:
INDIVIDUALBUSINESS
recipient_countrystring Required

Country of recipient represented in ISO 3166 format.

receiving_currencystring Required

Currency of recipient currency represented in ISO 4217 format.

payment_railstring Required

Payment rail of the recipient

Enum values:
LOCALSWIFT
statusstring

Status of the recipient

Enum values:
CREATEDPENDINGPENDING_REVIEWPENDING_ACTIVATIONACTIVEDELETEDFAILEDBLOCKEDUPDATE_REQUIREDINACTIVE
created_bystring

ID of the user who has created the recipient.

created_atstring

Created timestamp value of recipient

updated_bystring

ID of the user who has updated the recipient.

updated_atstring

Updated timestamp value of recipient

deleted_bystring

ID of the user who has deleted the recipient.

deleted_atstring

Deleted timestamp value of a recipient. it would only populated if recipient is deleted.

commentsstring

It respresents the reason of the activity

userobject

Represents the user object with id and type.

Show child attributes

bank_detailsobject

Object to represent recipients bank details

Show child attributes

address_detailsobject

Object to represent recipient address details.

Show child attributes

user_informationobject

Object to represent recipients basic details. this is required if recipient is type "INDIVIDUAL". If recipient type is BUSINESS, then we must be using business information

Show child attributes

business_informationobject

this object is mandatory if the recipient is of type business. this object is not supported for recipient of type INDIVIDUAL.

Show child attributes

representative_infoobject

this is an optional object. this is supported when the recipient is of type BUSINESS. This object is not required if the the recipient is of type INDIVIDUAL.

Show child attributes

identification_detailsobject,null

Represents the Identification details for individual recipient or business recipient.

Show child attributes

additional_dataobject Required

the additional data is required to process remittance. the values depend on the recipient's country.

Show child attributes

400
Object
Bad Request | **Code** | **Title** | **Detail** | | ---------------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------| | invalid_recipient_id | Invalid Recipient ID | Recipient does not exist. Please provide a valid recipient id. |

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

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