Download OpenAPI specification:Download
Convenient Checkout Gateway API - Prod
This api is used for creating the session id that is required to load the convenient checkout widget. Refer docs for widget setup. When Customer information is not present or insufficient, the checkout will be a guest experience.
X-Merchant-Id required | string <uuid> Merchant Identifier More info |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
object (PaymentDetail) payment details | |
object (Customer) customer details | |
object (Appearance) Custom Styling More info | |
object (SessionConfig) | |
object (Agent) | |
object (Consent) | |
object (SessionPaymentMethod) |
{- "payment": {
- "merchantTransactionId": "string",
- "amount": 1,
- "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "authorizeCard": false,
- "partialAuthorization": false,
- "statementDescriptorSuffix": "string",
- "paymentDescription": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "appearance": {
- "font": {
- "fontFamily": "Dosis, 'Optum Sans'",
- "fontSources": [
- {
- "src": "url('https://walletprod.healthsafepay.com/wallet/assets/fonts/OptumSans-Regular.woff2')",
- "family": "Optum Sans",
- "style": "normal",
- "weight": "400"
}
]
}, - "palette": {
- "primary": {
- "main": "#110022",
- "light": "#808080",
- "dark": "#4f1919",
- "contrastText": "#ff0022"
}, - "secondary": {
- "main": "#110022",
- "light": "#808080",
- "dark": "#4f1919",
- "contrastText": "#ff0022"
}
}, - "visibility": {
- "headerLogo": true,
- "hideApplicationLanguageSelector": false
}, - "border": {
- "alertBoxBorderRadius": "string",
- "buttonBorderRadius": "string"
}, - "height": {
- "button": 40
},
}, - "config": {
- "modes": [
- "PAYMENT"
], - "paymentMethodChannel": {
- "card": [
- "TERMINAL"
], - "bankAccount": [
- "TERMINAL"
]
}, - "privacyPolicyUrl": "string",
- "senderEmailAddress": "string",
- "options": {
- "saveDisabled": false,
- "preferredLanguage": "en",
- "paymentMethodSaveMode": "ALLOW_SAVE"
}, - "merchant": {
- "name": "string"
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
{- "url": "string",
- "data": {
- "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
- "hostedUrl": "string"
}, - "error": "string"
}
This api is used for getting the session details that is required to get the status of convenient checkout widget. Refer docs for widget setup. When Customer information is not present or insufficient, the checkout will be a guest experience.
sessionId required | string <uuid> |
X-Merchant-Id required | string <uuid> Merchant Identifier More info |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
{- "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
- "data": {
- "paymentMethodResponse": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "payment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}, - "status": "INITIATED"
}
}
merchantTransactionId required | string <= 50 characters Unique identifier that can be used to track this transaction. This identifier will make sure that there wont be any duplicate transaction. |
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
amount required | integer <int64> [ 1 .. 100000000 ] Amount in Cents (United States) |
object (Customer) customer details | |
object (IIASPaymentDetails) | |
object Payment metadata key value pairs. Example - Order Id, Invoice date etc. Max 20 metadata entries. Max key length is 40. Max value length is 100. | |
paymentType | string Deprecated Enum: "SALE" "PRE_AUTH" |
authorizeCard | boolean Default: false When authorizeCard is set as true, the credit card will be authorized for the amount supplied. Later we need to call the Capture API to complete the transaction. The authorization is valid only for 7 days. Applicable payment method types = [CARD] |
partialAuthorization | boolean Default: false When true, card issuers will consider the payment for partial authorization. This flag shall be provided in combination with authorizeCard flag. Applicable payment method types = [CARD] |
paymentMethodId required | string <uuid> Payment method Id of the saved card/bankAccount. To get the payment method Id refer /payment-methods/search API. |
paymentDescription | string <= 100 characters Payment description that will be useful for user to identify the payment. |
merchantTransactionId required | string <= 50 characters Unique identifier that can be used to track this transaction. This identifier will make sure that there wont be any duplicate transaction. |
statementDescriptorSuffix | string <= 10 characters ^(?=.*[a-zA-Z])[a-zA-Z0-9 \-.]{0,10}$ Must contain a letter. Learn more about statement descriptors in docs. |
object (Agent) | |
object (Consent) | |
authRequired | boolean |
{- "amount": 1,
- "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentDescription": "string",
- "merchantTransactionId": "string",
- "statementDescriptorSuffix": "string",
- "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "authRequired": true
}
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
paymentId required | string <uuid> |
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
paymentId required | string <uuid> PaymentId for the authorized payment |
X-Merchant-Id required | string <uuid> Merchant Identifier More info |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
amount | integer <int64> [ 1 .. 100000000 ] Amount in Cents (United States). Max Capture amount is limited by the original authorized amount. If no amount is specified, it attempts to capture the full authorized amount |
object Additional payment metadata. This metadata will be merged with the original payment metadata used for authorizing this payment. Max 20 metadata entries. Max key length is 40. Max value length is 100. |
{- "amount": 1,
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
paymentId required | string <uuid> PaymentId for the payment |
X-Merchant-Id required | string <uuid> Merchant Identifier More info |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
paymentCancellationReason required | string Enum: "DUPLICATE" "FRAUDULENT" "REQUESTED_BY_CUSTOMER" "ABANDONED" Payment Cancellation Reason |
paymentCancellationMessage | string |
{- "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string"
}
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
Refund request can only processed either by paymentId or by valid paymentMethodId associated with customer.
paymentId | string <uuid> paymentId of the payment that needs refund |
paymentMethodId | string <uuid> paymentMethodId that receives the refund. This is not applicable when paymentId is specified. |
amount | integer <int64> [ 1 .. 100000000 ] Amount in Cents (United States) and required when paymentMethodId is present. For refund associated with payments, if amount not provided full amount will be refunded. |
reason | string Enum: "REQUESTED_BY_CUSTOMER" "DUPLICATE" "FRAUDULENT" |
merchantTransactionId required | string [ 0 .. 50 ] characters |
object Additional payment metadata. Max 20 metadata entries. Max key length is 40. Max value length is 100. | |
object (Customer) customer details | |
object (Agent) |
{- "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "amount": 1,
- "reason": "REQUESTED_BY_CUSTOMER",
- "merchantTransactionId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "amount": 0,
- "reason": "REQUESTED_BY_CUSTOMER",
- "merchantTransactionId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "status": "INITIATED",
- "error": {
- "error": "string",
- "status": 0
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
refund-id required | string <uuid> |
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "amount": 0,
- "reason": "REQUESTED_BY_CUSTOMER",
- "merchantTransactionId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "status": "INITIATED",
- "error": {
- "error": "string",
- "status": 0
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
object (Customer) customer details | |||||||||||||||||||||||
|
{- "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}
]
payment-method-id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
[- {
- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}
}
]
payment-method-id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
isDefault | boolean |
nickname | string <= 30 characters can only contain letters and numbers (cannot contain card number applicable only for cards) |
object Deprecated Deprecated in favour of paymentMethodDetails. | |
object (Agent) | |
UpdateCard (object) or UpdateUSBankAccountDetails (object) |
{- "isDefault": true,
- "nickname": "string",
- "card": {
- "expiryYear": 0,
- "expiryMonth": 0,
- "nameOnCard": "string",
- "zipCode": "99950",
- "manufacturerCard": true
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}
[- {
- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}
}
]
payment-method-id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
Content-Type required | string Value: "application/json" |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
firstName | string <= 50 characters first name of the agent. This field is required for Agent flow. |
lastName | string <= 50 characters last name of the agent. This field is required for Agent flow. |
userId | string <= 50 characters msid of the agent. This field is required for Agent flow. |
isAccessVerified | boolean when merchant verifies access for the agent to allow entry of 16 digit card number, this can be set to true. |
{- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
{- "title": "string",
- "detail": "string",
- "status": 0
}
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
requestId | string <uuid> |
object (Customer) customer details | |
object (SavePaymentMethodToken) |
{- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentMethod": {
- "type": "CARD",
- "vendorPaymentMethodId": "string",
- "vendor": "STRIPE",
- "default": true,
- "card": {
- "nameOnCard": "string"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "nameOnCard": "string"
}, - "sourceProvider": {
- "name": "CCG"
}
}
}
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "status": "INITIALIZED"
}, - "warning": {
- "code": "DUPLICATE_ENTRY",
- "title": "string",
- "description": "string"
}
}
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "status": "INITIALIZED"
}, - "warning": {
- "code": "DUPLICATE_ENTRY",
- "title": "string",
- "description": "string"
}
}
X-Merchant-Id required | string <uuid> |
X-Upstream-Env required | string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod |
X-source | string <string> <= 50 characters Specify the Source System Identifier |
amount required | integer <int64> [ 1 .. 100000000 ] Amount in Cents (United States) |
object (Customer) customer details | |
object (IIASPaymentDetails) | |
object (PaymentMethodToken) | |
object Payment metadata key value pairs. Example - Order Id, Invoice date etc. Max 20 metadata entries. Max key length is 40. Max value length is 100. | |
paymentType | string Deprecated Enum: "SALE" "PRE_AUTH" |
authorizeCard | boolean Default: false When authorizeCard is set as true, the credit card will be authorized for the amount supplied. Later we need to call the Capture API to complete the transaction. The authorization is valid only for 7 days. |
partialAuthorization | boolean Default: false When true, card issuers will consider the payment for partial authorization. This flag shall be provided in combination with authorizeCard flag. Applicable payment method types = [CARD] |
paymentMethodId | string <uuid> Payment method Id of the saved card/bankAccount. To get the payment method Id refer /payment-methods/search API. |
paymentDescription | string <= 100 characters Payment description that will be useful for user to identify the payment. |
merchantTransactionId required | string <= 50 characters Unique identifier that can be used to track this transaction. This identifier will make sure that there wont be any duplicate transaction. |
statementDescriptorSuffix | string <= 10 characters ^(?=.*[a-zA-Z])[a-zA-Z0-9 \-.]{0,10}$ Must contain a letter. Learn more about statement descriptors in docs. |
object (Agent) | |
object (Consent) |
{- "amount": 1,
- "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "paymentMethod": {
- "type": "CARD",
- "vendorPaymentMethodId": "string",
- "vendor": "STRIPE",
- "savePaymentMethod": true,
- "default": true,
- "nickname": "string",
- "nameOnCard": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "nameOnCard": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentDescription": "string",
- "merchantTransactionId": "string",
- "statementDescriptorSuffix": "string",
- "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}
}
{- "url": "string",
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "amount": 0,
- "authorizedAmount": 0,
- "capturedAmount": 0,
- "description": "string",
- "merchantTransactionId": "string",
- "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
- "paymentType": "SALE",
- "authorizeCard": false,
- "partialAuthorization": false,
- "currencyCode": "string",
- "customerId": "string",
- "status": "PENDING",
- "vendor": "STRIPE",
- "vendorPaymentId": "string",
- "vendorPaymentSecret": "string",
- "vendorMerchantId": "string",
- "statementDescriptorSuffix": "string",
- "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
- "paymentMethodType": "CARD",
- "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "customer": {
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "ssnLastFour": "string",
- "phoneNumber": {
- "countryCode": "string",
- "number": "string"
}, - "dateOfBirth": "2000-12-30",
- "zip5": "99950",
- "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
- "enterpriseId": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "paymentCancellationReason": "DUPLICATE",
- "paymentCancellationMessage": "string",
- "error": {
- "error": "string",
- "status": 0
}, - "paymentDetails": {
- "healthcare": {
- "iias": {
- "qualifiedAmount": 0,
- "qualifiedAmountDetails": {
- "prescriptionAmount": 0
}
}, - "visionAmount": 0
}
}, - "consent": {
- "merchantConsentId": "string",
- "merchantConsentText": "string",
- "collectionTimestamp": "string",
- "collectionDetails": {
- "type": "WEB",
- "web": {
- "ipAddress": "string",
- "userAgent": "string"
}, - "tel": {
- "inboundPhoneNumber": {
- "countryCode": "string",
- "number": "string"
}
}
}
}, - "paymentMethod": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "card": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}, - "default": true,
- "paymentMethodType": "CARD",
- "nickname": "string",
- "sourceProvider": {
- "name": "CCG"
}, - "paymentMethodDetails": {
- "type": "CARD",
- "last4": "string",
- "status": "ACTIVE",
- "cardBrand": "VISA",
- "expiryYear": 0,
- "nameOnCard": "string",
- "expiryMonth": 0,
- "zipCode": "99950",
- "manufacturerCard": true
}
}, - "agent": {
- "firstName": "string",
- "lastName": "string",
- "userId": "string",
- "isAccessVerified": true
}
}
}