Payments

Retrieve the PDF representation of the receipt for a given payment in base64 format. Provide paymentId and optionally isForMerchant (default: true) to indicate whether the receipt is for the merchant or customer copy.

Calculate the surcharge/fee rate for a given card BIN and amount. Returns the surcharge amount, rate, type, and card brand. Use this before charging to display the final amount to customers. tokenId is required only when using the Strictly gateway (alternative to binCard).

Create a payment and immediately flag it for settlement when capture=true (default). A payment can be made for a card or for an existing customer vault. Set capture=false to issue a pre-authorization only — call /capture separately to settle.

Customer vault: If charging a customer vault, the system uses the default payment method. Override with overrideDefaultPaymentMethod set to the desired customerVaultId.

Dual-pricing accounts: amount represents the card price; no surcharge or discount applies for Regular/Dualpricing accounts.

Sandbox/test mode: Use token 00000000-000000-000000-000000000000 to speed up integration without hitting the network.

To trigger a declined response: Pass an amount less than 1.00.

bypassSurcharge: Set to true to remove surcharge for exceptions.

card.number must be the masked card number from the tokenization form (e.g. 411111******1111), regex: \d{6}[*\.]+\d{4}.

Post a refund on a previously captured payment. Funds are returned to the original credit/debit card. You can refund the full amount or only a portion. Multiple partial refunds are allowed until the charge is fully refunded. Attempting to refund a fully-refunded payment will result in an error. amount is expressed in cents (e.g. 100 = $1.00).

Void an existing payment that has not yet been settled. Once voided, no additional charges can be made. For settled/captured payments, use the refund endpoint instead.

reason values: fraud, user_cancel, icc_rejected, icc_card_removed, icc_no_confirmation, pos_timeout.

Set receipt=true to send a receipt notification to the customer via email or SMS.

Flag a pre-authorized payment for settlement. Only payments created with capture=false can be captured. You can capture an amount equal to or less than the original pre-authorization. Uncaptured payments are not posted to the account until a settlement runs (by default, daily).

Retrieve the acknowledgment payload for the last terminal transaction. Used in terminal integration flows. type controls the response format: json (default) or text.

Retrieve a single payment record by ID.

Create a payment from a customer vault for each entry in the payments array. Equivalent to calling /charge for a customer multiple times. Processed asynchronously via a Pub/Sub queue — the response only confirms the job was queued. Poll individual payment IDs to check each charge result.

Required per-item fields: amount, customerVaultId. Optional: bypassSurcharge (true/false) to remove surcharge for exceptions.