Create a payment

post

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

To create a payment, you use a payment resource. They are a reference to the actual payment that happens at the payment gateway.

Payments handle customers' actual payments of previously defined orders.

Body Params

orderId

string

required

The identifier of Cleeng order

status

string

required

The status of payment, available statuses are rejected, authorized, cancelled, captured.

paymentOperation

string

required

Payment operation type: initial-payment, recurring-payment.

paymentDetailsId

string

The identifier of Cleeng payment details connected to Cleeng customer. Required when paymentDetails are not created in the call

paymentDetails

object

externalPaymentId

string

The payment identifier from external payment gateway system

rejectedReason

string

A reason of rejected payment, available when status equals rejected

refundedReason

string

A reason of refunded payment, available when status equals refunded

subscriptionId

string

Subscription identifier at Cleeng, it is used in order to define for which subscription recurring payment should be made.
Required conditionally - when paymentOperation is set to recurring-payment.

Headers

Content-Type

string

Defaults to application/json

Responses

Language

Credentials

Header

Response

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

application/json

200200

400400

401401

422422