Mark payment as paid

post https://api.cryptomus.com/v1/payment/mark-as-paid Copy

Allows the user to mark a payment as paid.

The operation is available only for payments with the following status combinations: status = active and payment_status = wrong_amount_waiting, or status = completed and payment_status = wrong_amount.

Since the payment processing flow is asynchronous, immediate status updates are not guaranteed. When the endpoint is called, a corresponding asynchronous task is created for further processing.

Request

Query parameters

NameParameter typeDefinition
uuidstringuuidrequired_without: order_iduuid of the payment
order_idstringrequired_without: uuidOrder ID in your systemThe parameter should be a string consisting of alphabetic characters, numbers, underscores, and dashes. It should not contain any spaces or special characters.

Parameter type

stringuuidrequired_without: order_id

Definition

uuid of the payment

Parameter type

stringrequired_without: uuid

Definition

Order ID in your systemThe parameter should be a string consisting of alphabetic characters, numbers, underscores, and dashes. It should not contain any spaces or special characters.

Request example


curl --location 'https://api.cryptomus.com/v1/payment/mark-as-paid' \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
    "order_id": "test_107"
}'
Copy

Response

Response example


1{
2  "state": 0,
3  "result": {
4    "success": true,
5    "message": "The request has been accepted and queued for processing."
6  }
7}
Copy

Possible errors

Validation errors

code : 422

example responses:


1{
2  "message": "Payment not found.",
3  "state": 1
4}
Copy

Internal server error

code : 500

example responses:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}
Copy