Request
| Property | Type | Required | Description |
|---|---|---|---|
currency | string | Required Calculate Surcharge requests only | The currency being used for the transaction. |
amount | string | Required | The amount of the transaction prior to surcharge. |
payment-method | string | Optional | The payment method of the transaction. If payment information such as credit-card is provided in the request, the payment method will be inferred automatically. |
pf-token | string | Required for Calculate Surcharge requests only if using Hosted Payment Fields | A Hosted Payment Fields token. |
wallet | container | Required Only if using Apple Pay or Google Pay | Refer to wallet. |
vaulted-shopper-id | integer | Optional Calculate Surcharge requests only | A Vaulted Shopper ID. |
credit-card | container | Required for Calculate Surcharge requests only if not using Hosted Payment Fields or vaulted shopper | Refer to credit-card. |
surcharge-info | container | Required Calculate Prorated Surcharge requests only | Refer to surcharge-info. |
Response
| Property | Type | Description |
|---|---|---|
currency | string | The currency used for the surcharge calculation. |
amount | string | The calculated amount of the surcharge. |
payment-method | string | The payment method of the transaction. Calculate Surcharge response only |
payer-details | container | Refer to payer-info. Calculate Surcharge response only |
credit-card | container | Refer to credit-card. |
surcharge-info | container | Refer to surcharge-info. |
