❖ MatchMove Banking API Specifications

Sections

Theme switcher

Add funds to user wallet

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

amountstring

Amount to load. Numeric and greater than zero. Required unless rule is supplied.

currencystring

Currency of the amount. Optional; defaults to the program's default currency.

emailstring

Receiver's email. One of the receiver-identifying fields.

mobile_country_codestring

Receiver's mobile country code (digits, max length 4). Must be supplied together with mobile.

mobilestring

Receiver's mobile number (digits, length 5-14). Must be supplied together with mobile_country_code.

user_idstring

Receiver's user hash id (alphanumeric, max length 32). One of the receiver-identifying fields.

card_idstring

Receiver card hash id (alphanumeric, max length 32). One of the receiver-identifying fields.

hashed_panstring

Hashed PAN of the receiver card (max length 64). One of the receiver-identifying fields.

proxy_numberstring

Proxy number of the receiver card (max length 16). One of the receiver-identifying fields.

load_cardstring

When true, funds are loaded directly onto the identified card and receiver-contact criteria are not required. Optional.

Enum values:
true
detailsstring

Free-text transaction details (max length 512). Optional.

forwarded_forstring

Originating actor reference (alphanumeric, max length 32). Optional.

fund_category_namestring

Fund category to allocate the load to. Optional.

allow_split_category_transactionstring

When true, the load can be split across categories using rule. Optional.

Default value
false
Enum values:
truefalse
used_deducting_category_allocationstring

When true, the deducting category allocation is used. Cannot be combined with allow_split_category_transaction=true. Optional.

Default value
false
Enum values:
truefalse
rulestring

JSON-encoded array of category allocation rules (each with an amount). When supplied, allow_split_category_transaction must be true and amount is computed from the rule. Optional.

transfer_ref_idstring

Reference id used to initialise a money-transfer receiver flow. Optional.

Response

200
Object

Funds added to wallet successfully.

Response Attributes

idstring

Transfer identifier.

senderobject
recipientobject
messagestring

Optional message attached to the transfer.

statusstring

Transfer status.

amountstring

Transfer amount.

currencystring

Transfer currency (ISO 4217).

feesarray

Fees applied to the transfer.

dateobject
confirmstring

Whether confirmation is required (confirm_required) or skipped (confirm_skip).

linksarray

Confirmation links. Present when confirmation is required.

sor_transactionobject | null

System-of-record transaction reference. Null when not configured.

400
Object

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

Possible error codes:

  • resource_card_fund_transfer_id_required - Transfer id is required
  • resource_card_fund_transfer_record_not_found - Transaction 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

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:

  • resource_user_lockout - User currently has a pending transaction

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?