Payments

Create a card payment

Changed on

Creates a payment using a debit or credit cards.

post/v1/Payments/card

Request

Request body

save_payment_informationboolean

Save the card information on the customer profile for future transactions

customer_idinteger required

Primary identifier of customer to create this payment for.

amountnumber double required

Amount to create this payment for.

reference_numberstring

The reference number of this payment. This will be overwritten by the payment vendor if processed digitally through a payment gateway.

received_datestring date-time

Specify the date this payment was received.

payment_method_idinteger

Optionally specify the payment_method_id to choose a payment method type.

notestring

Optional note associated with this payment.

Response

Created

okboolean
idinteger

Changes

    • breaking

      request body became required

    • breaking

      the / request property's min was increased to 2026.00 (media type: application/json)

    • breaking

      the / request property's min was increased to 2026.00 (media type: text/json)

    • breaking

      the / request property's min was increased to 2026.00 (media type: text/html)

    • warning

      removed the request property / (media type: application/json)

    • warning

      removed the request property / (media type: text/json)

    • warning

      removed the request property / (media type: text/html)

    • info

      added the new optional request property / (media type: application/json)

    • info

      added the new optional request property / (media type: text/json)

    • info

      added the new optional request property / (media type: text/html)

    • info

      added the new optional request property / (media type: application/json)

    • info

      added the new optional request property / (media type: text/json)

    • info

      added the new optional request property / (media type: text/html)

    • info

      added the new optional request property / (media type: application/json)

    • info

      added the new optional request property / (media type: text/json)

    • info

      added the new optional request property / (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      the request property / became optional (media type: application/json)

    • info

      the request property / became optional (media type: text/json)

    • info

      the request property / became optional (media type: text/html)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: text/json)

    • info

      the request property became optional (media type: text/html)