❖ MatchMove Banking API Specifications

Sections

Theme switcher

List consumer transactions

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

typestring

Filter the history by movement type. debit/credit filter on the record sub_type; remittance filters on the record type.

Enum values:
debitcreditremittance
transaction_ref_idstring

Filter the history to a specific transaction reference id.

from_datestring

Start of the date range (inclusive). Must be supplied together with to_date; the range cannot exceed 90 days.

to_datestring

End of the date range (inclusive). Must be supplied together with from_date; the range cannot exceed 90 days.

records_per_pagestring

Number of records to return per page. Defaults to 5 and must not exceed the allowed maximum.

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.

consumer_keystring Required

Consumer key whose prefund history is being retrieved. Requires administrative scope to view another consumer's history.

pagestring Required

Page number of the records to retrieve. Results are ordered newest-first.

Response

200
Object

Consumer prefund balance history retrieved successfully.

Response Attributes

transactionsarray
400
Object

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

Possible error codes:

  • parameter_consumer_key_invalid - The supplied consumer_key does not match a known consumer
  • parameter_type_invalid - type must be one of debit, credit or remittance
  • parameter_from_to_date_invalid - from_date and to_date must both be supplied and be valid dates
  • parameter_from_to_date_range_invalid - Date range of from_date & to_date is invalid
  • resource_query_records_per_page_notnumber - records_per_page parameter must contain only digits
  • resource_query_records_per_page_exceeded - records_per_page parameter must not exceed the allowed maximum
  • resource_user_date_range_exceeded - Date range interval should not be greater than 90 days.

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:

  • resource_not_found - Resource not 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?