API explorer
⁍ MatchMove Banking Operating System

Sections

API explorer

Theme switcher

Get quote details

Header Parameters

X-Auth-User-IDstring Required

MatchMove provided ID for the user.

Authorizationstring

Path Parameters

idstring Required

Unique reference for quote created.

Response

200
Object
OK

Response Attributes

idstring

Quote ID

expirystring

Quote expiry in program timezone format

delivery_timestring

Expected human readable time for the transaction to complete

Enum values:
INSTANTNEAR REAL-TIMESAME DAYNEXT DAY2 DAYS
statusstring

Status of the quote

Enum values:
INITIATEDFAILEDCONFIRMEDEXPIREDCONSUMEDCANCELLED
sub_statusstring

Sub status of the quote

Enum values:
DOCUMENT_REQUIRED
document_required_typesarray

Types of documents to be uploaded when document is required

Enum values:
INVOICE

Show child attributes

typestring

Represents the type of the quote. Helps to identify whether conversion happen at user currency or the recipient currency.

Default value
FORWARD
Enum values:
FORWARDREVERSE
source_countrystring

Represents the source country of the quote. Represented in ISO 3166 format.

source_currencystring

Represents the source currency of quote. Represented in ISO 4217 format.

destination_countrystring

Represents the destination country of the quote. Represented in ISO 3166 format.

destination_currencystring

Destination currency of the quote. Represents in ISO 4217 format.

recipient_typestring

Represents the type of the recipient

Enum values:
INDIVIDUALBUSINESS
receiving_institution_typestring

Represents the type of receiving institution

Enum values:
BANKCARDSCASH_PICKUPMOBILE_WALLET
payment_railstring

Represents the payment rail to be used for the transaction

Enum values:
LOCALSWIFT
charge_typestring

To specify which party bears the bank fee.
OUR means that the sender will pay the fee.
SHA means that both the sender and the recipient will pay the fee.

Enum values:
OURSHA
userobject

Show child attributes

charged_amountobject

Represents the amount charged to user

Show child attributes

converted_amountobject

Represents the amount which is sent to the recipient after fee deduction

Show child attributes

recipient_amountobject

Represents the amount the recipient would receive

Show child attributes

feesobject

This object represents fee applied at different level. Segregated at level of program, user and net fee applied for a quote.

Show child attributes

fx_rateobject

Represents details of conversion rate provided to user

Show child attributes

created_bystring

Represents the ID of user who raised the quote request

created_atstring

Represents the creation date and time of the quote

400
Object
Bad Request | **Code** | **Title** | **Detail** | | ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | invalid_user_id | Invalid User ID | User does not exist. Please provide a valid user 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 | **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. | | unauthorized_access | Unauthorized Access | Quote does not belong to user. |

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. | | quote_not_found | Quote Not Found | Quote details not found for the given 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

500
Object
Internal Server Error | **Code** | **Title** | **Detail** | | ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | generic_error | General 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