API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE

Update a payment

patch
https://api.sandbox.cleeng.com/3.1/payments/

To update a payment, you use payments resource. They are a reference of the actual payment that happens at the payment gateway.

Payments handle customers' actual payments of previously defined order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
paymentOperation valuedescription
initial-paymentuse when a customer is purchasing the order in the checkout
initial-free-transactionuse when the customer is not charged, for example, if he has a trial period applied, or got a 100% coupon code
recurring-paymentuse when the customer is charging for renewal payment
Path Params
int32
required
Body Params
int32
required

The identifier of Cleeng order. Required when status ≠ refunded.

string
required

The status of payment, available statuses are rejected, captured, refunded.

string

Payment operation type: initial-payment, initial-free-transaction, recurring-payment. Required when status ≠ refunded.

string

The payment identifier from external payment gateway system

paymentDetails
object
string

A reason of rejected payment. Required only when status equals rejected.

string

A reason of refunded payment. Required only when status equals refunded.

float

Refunded amount. Values bigger than 0.0

string

Type of refund: refundor chargeback

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago