RErev-io
Payments

Create a new payment

Changed on

If no Payment Account ID is passed the method is the first available non ACH/CC method of your instance.

post/v1/Payments

Request

Request body

payment_account_idinteger

Foreign identifier representing the payment account you wish to process the payment with.

bill_idinteger

Foreign identifier representing the bill to apply the payment to.

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

  • f175f5a3b11dRevision changes
    • breaking

      request body became required

    • 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)