Process SuperPay payment
POST/orders/:guid/payments/superpay/process
Starts payment now or releases a hold if there was one, then starts collection immediately. On manual flow this is your main trigger to start payment. On automatic flow is used to pay ahead of the schedule or to release a hold.
Request
Responses
- 200
- 401
- 403
- 404
- 408
- 409
- 410
- 429
The updated payment
Not authenticated
Forbidden
ORDER_NOT_FOUND: no such order, or the order is not yours.
REQUEST_TIMED_OUT: the payment provider did not answer in time. Read the payment to see whether the action took effect, then retry.
The order or payment state does not allow the action. Codes include:
ORDER_NOT_DELIVERED: the order is not delivered yet.DELIVERY_NOT_VERIFIED: manual flow, mark the delivery as verified first.CHARGE_ALREADY_STARTED: collection is already running.PAYMENT_ALREADY_PAID: the carrier is already paid.PAYOUT_ALREADY_STARTED: funds are moving to the carrier.PAYMENT_FAILED: the payment failed; Super Dispatch support retries it, not the API.PAYMENT_CANCELED: the payment is canceled.CARRIER_NOT_ELIGIBLE: automatic flow, no payment record yet, and the carrier has not enabled SuperPay.SUPERPAY_NOT_ENABLED: SuperPay is not active on your account.ACCOUNT_SUSPENDED: your SuperPay account is suspended; contact support.ORDER_RESTRICTED: SuperPay cannot start on this order because of its origin.PAYMENT_PROVIDER_ERROR: the payment could not be processed; read the payment, then retry.
ORDER_IS_DELETED: the order is deleted
CONCURRENT_REQUEST: another write on this order is in flight. Retry after a few seconds.