OAuth Card Order Delivery Address Serviceability Check
Path Parameters
Program code identifier
Card type code identifier
Body Parameters
Address line 1
Address line 2
Address line 3. If applicable, use the code field from the enum response of v2/users/enumerations/line_3, otherwise free text.
Address line 4. If applicable, use the code field from the enum response of v2/users/enumerations/line_4, otherwise free text
CCity. If applicable, use the code field from the enum response of v2/users/enumerations/city, otherwise free text.
State. If applicable, use the code field from the enum response of v2/users/enumerations/state_province, otherwise free text.
Zip Code. If applicable, use the code field from the enum response of v2/users/enumerations/postal_code, otherwise free text.
Country name.
Country code.Allowed values accesible via /v2/users/enumerations/countries
Response
Serviceability check completed successfully
Response Attributes
Show child attributes
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
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
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
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
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
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Not Found
Possible error codes :
resource_not_found : Resource Not Found — The requested URL was not found
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Internal Server Error
Possible error codes :
generic_error : General Error — General application error
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Bad Gateway
Possible error codes :
bad_gateway : Bad Gateway — Bad gateway error.
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Service Unavailable
Possible error codes :
service_unavailable : Service Unavailable — Service is temporarily unavailable.
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Gateway Timeout
Possible error codes :
gateway_timeout : Gateway Timeout — Gateway timeout error.
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API