Hold SuperPay payment

POST 
/orders/:guid/payments/superpay/hold

Pauses the payment before the carrier transfer starts. A hold has no expiry, the payment waits for process schedule or cancel call. If collection has started, it completes and the funds wait with Super Dispatch.

Request

Responses

200

The updated payment

400

VALIDATION_ERROR: custom_text is longer than 160 characters.

401

Not authenticated

403

Forbidden

404

ORDER_NOT_FOUND: no such order, or the order is not yours.

408

REQUEST_TIMED_OUT: the payment provider did not answer in time. Read the payment to see whether the action took effect, then retry.

409

The payment state does not allow a hold. Codes include:

• PAYMENT_NOT_INITIALIZED: there is no payment record yet.
• PAYMENT_ALREADY_ON_HOLD: you already hold this payment.
• PAYMENT_ALREADY_PAID: the carrier is already paid.
• PAYOUT_ALREADY_STARTED: funds are moving to the carrier.
• PAYMENT_CANCELED: the payment is canceled.

410

ORDER_IS_DELETED: the order is deleted

429

CONCURRENT_REQUEST: another write on this order is in flight. Retry after a few seconds.