❖ MatchMove Banking API Specifications

Sections

Theme switcher

Create a card fund category

Header Parameters

X-Auth-User-IDstring Required

The matchmove issued user_id for which the request is being made

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

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.

Body Parameters

namestring Required

Fund category name. Case-insensitive alphanumeric combinations with hyphens. Must be unique and cannot be "DEFAULT".

default_amountstring

Default limit amount for the category. Must be numeric and greater than zero, or null to clear it. Optional.

factorstring

Amount type factor. Only UNIT is supported. Optional.

Default value
UNIT
Enum values:
UNIT
prioritystring

Category priority. Numeric, non-zero and must be unique. Optional; auto-assigned when omitted.

cardstring

Comma-separated list of card hash ids to filter the category on. Optional.

mccstring

Comma-separated list of MCC codes to filter the category on. Optional.

countrystring

Comma-separated list of ISO 3166 alpha-3 country codes to filter the category on. Optional.

merchantstring

Comma-separated list of merchant ids to filter the category on. Optional.

terminalstring

Comma-separated list of terminal ids to filter the category on. Optional.

Response

200
Object

Fund category created successfully.

Response Attributes

idnumber

Fund category identifier.

namestring

Fund category name.

default_amountstring

Default amount allocated to the category.

factorstring

Allocation factor for the category.

prioritynumber

Category priority ordering.

cardarray

Cards associated with this category.

mccarray

Merchant category codes bound to this category.

currencyarray

Currency codes bound to this category.

merchantarray

Merchant codes bound to this category.

terminalarray

Terminal codes bound to this category.

is_activeboolean

Whether the category is active.

date_addedstring

Timestamp the category was created.

400
Object

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

Possible error codes:

  • resource_card_fund_category_name_exists - Category name already exists and cannot be used
  • resource_card_fund_category_amount_invalid - The default amount given is missing or invalid
  • resource_card_fund_category_priority_invalid - The priority given is invalid
  • resource_card_fund_category_priority_exists - Category priority already exists and cannot be used
  • resource_card_fund_category_is_active_invalid - The is_active value is invalid
  • resource_card_fund_category_card_invalid - One or more card values given is not supported
  • resource_card_fund_category_mcc_invalid - One or more MCC values given is not supported
  • resource_card_fund_category_country_invalid - One or more Country values given is not supported

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?

POST

/

Select
1

Response

Was this section helpful?