CLcleeng

Update a payment

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.

patch/payments/{paymentId}

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/payments/{paymentId}
  • Auth
    API key in header X-Publisher-Token

Path parameters

paymentIdinteger required

Headers

Content-Typestring

Request body

orderIdinteger required

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

statusstring required

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

paymentOperationstring

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

externalPaymentIdstring

The payment identifier from external payment gateway system

rejectedReasonstring

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

refundedReasonstring

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

refundedAmountnumber float

Refunded amount. Values bigger than 0.0

refundTypestring

Type of refund: refundor chargeback

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "payment": {
    "paymentId": 123456,
    "publisherId": 123456789,
    "orderId": 654321,
    "paymentDetailsId": 987654321,
    "paymentStatus": "captured",
    "paymentOperation": "initial-payment"
  },
  "message": "Payment updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.