❖ MatchMove Banking API Specifications

Sections

Theme switcher

OAuth Card Order Delivery Address Serviceability Check

Path Parameters

program_codestring Required

Program code identifier

card_type_codestring Required

Card type code identifier

Body Parameters

address_1string

Address line 1

Max length
35
address_2string

Address line 2

Max length
35
address_3string Required

Address line 3. If applicable, use the code field from the enum response of v2/users/enumerations/line_3, otherwise free text.

Max length
35
address_4string

Address line 4. If applicable, use the code field from the enum response of v2/users/enumerations/line_4, otherwise free text

Max length
35
citystring Required

CCity. If applicable, use the code field from the enum response of v2/users/enumerations/city, otherwise free text.

Max length
20
statestring Required

State. If applicable, use the code field from the enum response of v2/users/enumerations/state_province, otherwise free text.

Max length
20
zipcodestring

Zip Code. If applicable, use the code field from the enum response of v2/users/enumerations/postal_code, otherwise free text.

countrystring

Country name.

Max length
50
country_codestring Required

Country code.Allowed values accesible via /v2/users/enumerations/countries

Max length
3

Response

200
Object

Serviceability check completed successfully

Response Attributes

dataarray
Max items
10
400
Object

Bad Request

Possible error codes :

validation_error : Validation Error — Validation errors

parameter_consumer_invalid : Parameter Consumer Invalid — Invalid consumer

card_type_code_not_found : Card type code not found

card_type_code_not_active : Card type code not active

unsupported_card_type : Unsupported Card Type — This feature is applicable only for personalized physical cards

invalid_address_combination : Invalid address combination — Invalid state & city combination entered by user

address_not_serviceable : Address Not Serviceable — Logistics provider do not provide service or delivery to the specified address.

invalid_model : Invalid Model — Request body is invalid

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

401
Object

Unauthorized Request

Possible error codes :

token_required : Token Required — Missing authentication token on header

access_denied : Access Denied — Access is denied for this resource

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

403
Object

Forbidden

Possible error codes :

restricted_resource : Restricted Resource — Access denied to the resource.

feature_not_enabled : Feature Not Enabled — Card order serviceability check feature is not enabled

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

404
Object

Not Found

Possible error codes :

resource_not_found : Resource Not Found — The requested URL was not found

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

500
Object

Internal Server Error

Possible error codes :

generic_error : General Error — General application error

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

502
Object

Bad Gateway

Possible error codes :

bad_gateway : Bad Gateway — Bad gateway error.

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

503
Object

Service Unavailable

Possible error codes :

service_unavailable : Service Unavailable — Service is temporarily unavailable.

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

504
Object

Gateway Timeout

Possible error codes :

gateway_timeout : Gateway Timeout — Gateway timeout error.

Response Attributes

idstring Required

Unique request ID for the API request

statusnumber Required

HTTP response code for the API request

codestring Required

MatchMove generated error code for the API request

titlestring Required

MatchMove generated title for the error code

detailstring Required

Details for the error code

descriptionstring

Details for the error code

sourcearray | null

Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons

timestampstring Required

Timestamp for the processed API

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?