Replace a payment with a card

Replaces an eligible failed payment by charging a supplied credit card immediately.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired
Failed payment identifier.

Request

This endpoint expects a multipart form.
merchant_account_idintegerRequired
payment_amountdoubleRequired>=0.01
card_tokenstring or nullOptional
credit_card_numberstring or nullOptional
credit_card_exp_datestring or nullOptionalformat: "^\\d{4}-\\d{2}$"
credit_card_cvcstring or nullOptional
customer_billing_namestringRequired
customer_address_1stringRequired
customer_address_2string or nullOptional
customer_citystringRequired
customer_statestringRequired
customer_zipstringRequired
customer_countrystringRequired
customer_phonestringRequired
customer_emailstring or nullOptionalformat: "email"
fees_prioritylist of integers or nullOptional
notestring or nullOptional<=255 characters

Response

Replacement card payment processed
statusstringOptional
messagestringOptional
dataobjectOptional
PaymentResource for the replacement.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error