latestOpenAPI 3.0.32026-08-215925112.0 MB
36be0dca14e7
api
payment-requests
Change Payment Request Payment Status
post/api/payments/requests/{id}/payment-status
Path parameters
idstring required
The ID of the payment request
Request body
paymentStatus'SUCCEEDED' | 'FAILED' required
The new payment status
gatewaySecretstring required
The secret of the payment gateway responsible for the payment
Response
OK
_idstring required
The ID of the payment request
secretstring required
The secret token of the payment request
amountnumber float
The amount which needs to be paid
currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'
An ISO 4217 3-character code of the currency
checkoutIdstring
The ID of the checkout that request belongs to
subscriptionIdstring
The ID of the subscription that request belongs to
paymentPlanIdstring
The ID of the payment plan that request belongs to
paymentGatewayIdstring
The ID of the payment gateway responsible for the payment
referencestring
status'NEW' | 'SUCCEEDED' | 'CANCELED' required
sellerIdstring required
expiresAtstring date-time
An ISO timestamp indicating when the payment request will expire and a new one will be created if requested
createdAtstring date-time required
An ISO timestamp indicating when the payment request was created
updatedAtstring date-time required
An ISO Timestamp indicating when the payment request was last updated