Update a payment

patch

https://api.sandbox.cleeng.com/3.1/payments/{paymentId}

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

paymentId

int32

required

Body Params

orderId

int32

required

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

status

string

required

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

paymentOperation

string

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

externalPaymentId

string

The payment identifier from external payment gateway system

paymentDetails

object

rejectedReason

string

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

refundedReason

string

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

refundedAmount

float

Refunded amount. Values bigger than 0.0

refundType

string

Type of refund: refundor chargeback

Headers

Content-Type

string

Defaults to application/json

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

422422