❖ MatchMove Banking API Specifications

Sections

Theme switcher

Retrieve consumer wallet instruments

Header Parameters

X-Auth-User-IPstring

The IP using which the actor is making the request

X-Auth-Device-IDstring

The unique id of the device using which the actor is making the request

X-Auth-User-Agentstring

The user agent of the device using which the actor is making the request

X-Auth-Actorstring Required

The actor on behalf of whom the API request is being performed

Query Parameters

emailstring

Email address of the user whose instruments are being retrieved. One of email, user_id, or mobile + mobile_country_code is required.

user_idstring

Hash id of the user whose instruments are being retrieved. One of email, user_id, or mobile + mobile_country_code is required.

mobile_country_codestring

Mobile country code of the user. Must be supplied together with mobile.

mobilestring

Mobile number of the user. Must be supplied together with mobile_country_code.

card_type_codestring

Optional filter to return only cards of the given card type code.

card_idstring

Optional filter to return only the card matching this card hash id.

card_proxy_numberstring

Optional filter to return only the card matching this proxy number.

Path Parameters

program_codestring Required

Unique identifier for your program, issued by MatchMove during onboarding. All requests must use the program_code assigned to your integration. Using a program_code that does not belong to your integration will result in an authorization error.

Response

200
Object

Consumer instruments retrieved successfully.

Response Attributes

idstring

Wallet identifier.

numberstring

Account identification number for the wallet.

holderobject
fundsobject
dateobject
statusobject
cardsarray

Cards linked to this wallet.

400
Object

Bad Request The response code field indicates which specific rule was violated.

Possible error codes:

  • email_mobile_user_id_required - Parameter email or user_id or mobile_country_code and mobile is missing
  • resource_user_wallet_fund_mobile_insufficient_dependency - Both mobile_country_code and mobile must be specified
  • user_not_found - User not found or does not exist

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

401
Object

Unauthorized Request The response code field indicates which specific rule was violated.

Possible error codes:

  • invalid_token - Access denied due to invalid token on header

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

403
Object

Forbidden The response code field indicates which specific rule was violated.

Possible error codes:

  • access_denied - Access is denied for this resource

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

404
Object

Not Found The response code field indicates which specific rule was violated.

Possible error codes:

  • user_wallet_not_found - The wallet cannot be found

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

405
Object

Method Not Allowed The response code field indicates which specific rule was violated.

Possible error codes:

  • method_not_allowed - The HTTP method is not allowed here

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

500
Object

Internal Server Error The response code field indicates which specific rule was violated.

Possible error codes:

  • internal_error - An internal gateway error occurred

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

501
Object

Not Implemented The response code field indicates which specific rule was violated.

Possible error codes:

  • not_implemented - This operation is not implemented

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

502
Object

Bad Gateway The response code field indicates which specific rule was violated.

Possible error codes:

  • bad_gateway - Bad gateway error.

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

503
Object

Service Unavailable The response code field indicates which specific rule was violated.

Possible error codes:

  • service_unavailable - Service is temporarily unavailable

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

504
Object

Gateway Timeout The response code field indicates which specific rule was violated.

Possible error codes:

  • gateway_timeout - Gateway timeout error.

Response Attributes

idstring Required

Unique hash-id for the error message

statusnumber Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray

Source defines the multiple error messages

timestampstring Required

Response timestamp

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?