GET/////
Use this endpoint to return the status of a Click to Pay for Visa request.
For more information about this ecommerce checkout solution, see Click to Pay.
Header parameter
| Fields | Description |
|---|---|
| req-sys-id string Required | Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. Allowable Values: 36 char max |
| external-consumer-id-owner-bid string Required | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. Allowable Values: 1–8 chars |
URL path parameters
| Fields | Description |
|---|---|
| requestTraceId string Required | Unique identifier of the Visa Click to Pay request. Allowable Values: 1–36 chars |
Response body
| Fields | Description |
|---|---|
| status string Returned | Status of the operation. Allowable Values: IN_PROGRESS, COMPLETED |
| consumerInformation object Conditionally returned | Consumer information. Allowable Values: Existing consumerInformation object |
| consumerInformation.externalConsumerID string Conditionally returned | External consumer ID. Allowable Values: 1–100 chars |
| consumerInformation.externalConsumerIDOwnerBID string Conditionally returned | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. Allowable Values: 1–8 chars |
| details array of undefineds Conditionally returned | Additional status details of the operation. Allowable Values: Array of details object |
| details[].status string Returned | Status of the operation. Allowable Values: SUCCESS, FAILED |
| details[].intent object Returned | Intent of the Visa Click to Pay operation. Allowable Values: type, value |
| details[].intent.type string Returned | Type of the operation. Allowable Values: PRODUCT_CODE |
| details[].intent.value string Returned | Value of the operation. Allowable Values: CLICK_TO_PAY |
| details[].errorDetails array of objects Returned | Details of error occurred while executing the operation. Allowable Values: field, reason, message |
| details[].errorDetails[].field string Returned | Field that caused the error in the operation. Allowable Values: 1–100 chars |
| details[].errorDetails[].reason string Returned | Description of why the error has occurred. Allowable Values: 1–100 chars |
| details[].errorDetails[].message string Returned | Message describing the error. Allowable Values: 1–256 chars |
Sample response body
JSON
{
"status": "IN_PROGRESS",
"details": [
{
"intent": {
"type": "PRODUCT_CODE",
"value": "CLICK_TO_PAY"
},
"status": "SUCCESS",
"errorDetails": [
{
"field": "string",
"reason": "string",
"message": "string"
}
]
}
],
"consumerInformation": {
"externalConsumerID": "63421837-d597-4f0f-89e4-930c1a7b9e85",
"externalConsumerIDOwnerBID": "10098765"
}
}