Charge a one-time payment by card

POST

https://ssuccessv2.com/app/api/v2/payment/pay/:id/onetime/charge-now/credit-card

POST

/app/api/v2/payment/pay/:id/onetime/charge-now/credit-card

$ curl -X POST https://ssuccessv2.com/app/api/v2/payment/pay/901/onetime/charge-now/credit-card \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: multipart/form-data" \
>      -F merchant_account_id='3' \
>      -F payment_amount='125' \
>      -F credit_card_number="4111111111111111" \
>      -F credit_card_exp_date="2027-09" \
>      -F credit_card_cvc="123" \
>      -F customer_billing_name="David Cohen" \
>      -F customer_address_1="12 Main Street" \
>      -F customer_city="New York" \
>      -F customer_state="NY" \
>      -F customer_zip="10001" \
>      -F customer_country="US" \
>      -F customer_phone="+1-212-555-0199"

1 {
2   "status": "success",
3   "message": "Payment accepted.",
4   "data": {
5     "id": 902,
6     "amount_payment": 125,
7     "payment_status_id": 1,
8     "payment_method_id": 1,
9     "payment_type_id": 5,
10     "contract_id": 901
11   }
12 }

Immediately charges an existing scheduled payment with unsaved card details and applies the resulting transaction to its contract.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1

Existing payment identifier to charge.

Request

This endpoint expects a multipart form.

merchant_account_idintegerRequired

payment_amountdoubleRequired>=0.01

credit_card_numberstringRequired

credit_card_exp_datestringRequiredformat: "^\\d{4}-\\d{2}$"

credit_card_cvcstringRequired

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"

contract_fees_type_idinteger or nullOptional>=1

is_creditboolean or nullOptional

notestring or nullOptional

Response

The card payment result and payment resource were returned.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error