Sign in

v3

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0384241293.2 KB
UrlToPay

put/api/v1/urltopay/{id}/paymentdetails/{paymentId}

Path parameters

idstring uuid required
paymentIdstring uuid required

Request body

cardholderNamestring nullable
shortAccountNumberstring required
approvalTimestampstring date-time required
approvalCodestring required
cardType'Unknown' | 'AmericanExpress' | 'Visa' | 'Mastercard' | 'Discover' | 'Debit' | 'Gift' | 'Bankcard' | 'ChinaUnionPay' | 'DinersClub' | 'JCB' | 'Laser' | 'Maestro' | 'Solo' | 'Switch' | 'UATP' | 'OneWorldBancorp' | 'Paypal' required
paymentTokenstring byte nullable
externalIdstring nullable

Used to help differentiate payment history from new payments

netAmountnumber double required

The total amount of the charge for the payment (this INCLUDES gratuity)

includedGratuityAmountnumber double nullable

The specific amount that was applied to the total that was the gratuity

Response

Success

idstring uuid required
netAmountnumber double required
gratuityAmountnumber double required
status'Pending' | 'Canceled' | 'Complete' required
invoiceCreationTimestring date-time required
urlToPayUristring nullable