Pay orders with the prepaid credit
POST/api/v3/payments/prepaid-credit
Required scopes: payment:write
Pays one or more orders together with the prepaid credit. When there is nothing to pay (total 0.00) the orders are confirmed without a payment and the response is 204. The response is 409 when payments are not possible at this time, the orders cannot be paid together, the prepaid credit cannot be used for them (for example because it is not enough), or the payment exceeds the payment limits allowed at this time.
Not available to sub-accounts: the response is 403 (error 1601).
Request
Responses
- 201
- 204
- 400
- 401
- 402
- 403
- 404
- 409
- 429
- 500
Created
Response Headers
URL of the created resource
Nothing to pay (total 0.00): the orders are confirmed without a payment
The request is not valid: error 1000 with the errors for each field in meta.errors, error 1001 (or 1) for other invalid input
The access token is missing, invalid, expired or revoked (error 1100): request a new token and retry once
The payment provider declined the payment (error 1700): the message is the one of the provider, and the orders are still to be paid
The access token is valid but not enough: missing scope (error 1101), token for the other API (error 1102), missing permission, feature not included in the plan, operation not available to sub-accounts, internal API without administrator privileges or IP address not allowed (error 1601). A new token does not change the result
The resource does not exist or does not belong to the account (error 1200)
The request conflicts with a business rule or with the current state of the resource (error 1400)
Too many requests (error 1300): retry after the seconds in the Retry-After header
Response Headers
Seconds to wait before retrying
Unexpected server error (error 1500)