V1
{
"request": {
"headers": {
"Accept": "application/json",
"X-Merchant-Id": "string (uuid)"
},
"method": "GET",
"path": "/payments/{paymentId}" <MODIFIED>
},
"response": {
"agent": {
"firstName": "string | null",
"isAccessVerified": "boolean",
"lastName": "string | null",
"userId": "string"
},
"amount": "integer (int64)",
"authorizeCard": "boolean",
"authorizedAmount": "integer (int64)",
"capturedAmount": "integer (int64)",
"checkoutId": "string (uuid) | null",
"consent": {
"collectionDetails": {
"tel": {
"inboundPhoneNumber": {
"countryCode": "string",
"number": "string"
}
},
"type": "string (WEB | TEL | PPD)",
"web": {
"ipAddress": "string",
"userAgent": "string"
}
},
"collectionTimestamp": "string",
"merchantConsentId": "string",
"merchantConsentText": "string"
},
"currencyCode": "string (USD)",
"customerId": "string (uuid)" <REMOVED>,
"description": "string | null",
"id": "string (uuid)",
"merchantId": "string (uuid)" <REMOVED>,
"merchantTransactionId": "string",
"metadata": {
"<key>": "string"
},
"partialAuthorization": "boolean",
"paymentCancellationMessage": "string",
"paymentCancellationReason": "string",
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "integer (int64)",
"qualifiedAmountDetails": {
"prescriptionAmount": "integer (int64)"
}
},
"visionAmount": "integer (int64)"
}
},
"paymentMethodId": "string (uuid)" <REMOVED>,
"paymentType": "string (PRE_AUTH | SALE)" <REMOVED>,
"statementDescriptorSuffix": "string | null",
"status": "string",
"vendor": "string" <REMOVED>,
"vendorMerchantId": "string" <REMOVED>,
"vendorPaymentId": "string" <REMOVED>
}
}
V2
{
"request": {
"headers": {
"Accept": "application/json",
"X-Merchant-Id": "string (uuid)"
},
"method": "GET",
"path": "/v2/payments/{paymentId}" <MODIFIED>
},
"response": {
"agent": {
"firstName": "string | null",
"isAccessVerified": "boolean",
"lastName": "string | null",
"userId": "string"
},
"amount": "integer (int64)",
"authRequired": "boolean" <ADDED>,
"authorizeCard": "boolean",
"authorizedAmount": "integer (int64)",
"capturedAmount": "integer (int64)",
"checkoutId": "string (uuid) | null",
"consent": {
"collectionDetails": {
"tel": {
"inboundPhoneNumber": {
"countryCode": "string",
"number": "string"
}
},
"type": "string (WEB | TEL | PPD)",
"web": {
"ipAddress": "string",
"userAgent": "string"
}
},
"collectionTimestamp": "string",
"merchantConsentId": "string",
"merchantConsentText": "string"
},
"currencyCode": "string (USD)",
"customer": {
"id": "string"
} <ADDED>,
"description": "string | null",
"id": "string (uuid)",
"merchant": {
"groupId": "string | null",
"id": "string (uuid)",
"name": "string"
} <ADDED>,
"merchantTransactionId": "string",
"metadata": {
"<key>": "string"
},
"partialAuthorization": "boolean",
"paymentAllocations": [
{
"amount": "integer (int64)",
"authorizedAmount": "integer (int64)",
"capturedAmount": "integer (int64)",
"id": "string (uuid)",
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "integer (int64)",
"qualifiedAmountDetails": {
"prescriptionAmount": "integer (int64)"
}
},
"visionAmount": "integer (int64)"
}
},
"paymentMethod": {
"default": "boolean",
"id": "string (uuid)",
"nickName": "string",
"paymentMethodDetails": {
"accountHolderType": "string",
"accountType": "string",
"bankName": "string",
"cardBrand": "string",
"cardCategories": [
{
"medications": [
{
"label": "string",
"value": "string"
}
],
"type": "string"
}
],
"expiryMonth": "integer (int64)",
"expiryYear": "integer (int64)",
"last4": "string",
"nameOnAccount": "string",
"nameOnCard": "string",
"routingNumber": "string",
"status": "string",
"type": "string (CARD | BANK_ACCOUNT)",
"zipCode": "string"
},
"sourceProvider": {
"name": "string (CCG | GOOGLE_PAY | APPLE_PAY)"
}
},
"status": "string (COMPLETED | AUTHORIZED | ACCEPTED)",
"vendor": {
"merchantId": "string",
"name": "string (STRIPE)",
"paymentId": "string",
"paymentSecret": "string | null"
}
}
] <ADDED>,
"paymentCancellationMessage": "string",
"paymentCancellationReason": "string",
"paymentDateUtc": "string (date-time)" <ADDED>,
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "integer (int64)",
"qualifiedAmountDetails": {
"prescriptionAmount": "integer (int64)"
}
},
"visionAmount": "integer (int64)"
}
},
"statementDescriptorSuffix": "string | null",
"status": "string"
}
}