payments

Create a payment

Records a payment received from a customer, e.g. a bank transfer or check collected outside Paid. Allocate it to invoice lines with the payment allocations endpoints.

post/payments/

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/payments/
  • Auth: HTTP bearer

Request body

customerIdstring

Paid customer ID the payment belongs to.

externalCustomerIdstring

Your external customer ID the payment belongs to.

amountinteger required

Payment amount in cents (minor currency units).

currencystring required

Three-letter ISO currency code.

paymentDatestring date-time

When the payment was made (ISO 8601). Defaults to the current time.

paymentType'creditCard' | 'bankTransfer' | 'ach' | 'cash' | 'check' required

How the payment was made.

status'draft' | 'posted'

Initial status. Use draft to keep the payment editable, posted to record it as received. Defaults to posted.

metadataobject

Key-value metadata stored on the payment.

Response

201

idstring required

Unique payment identifier.

numberinteger required

Sequential payment number within your organization (shown as "PAY-0001").

customerIdstring required

The customer this payment belongs to.

invoiceIdstring nullable required

The invoice this payment was collected for, when created by an automatic charge. Null for manually recorded payments.

orderIdstring nullable required

The order this payment relates to, when known.

amountinteger required

Payment amount in cents (minor currency units).

allocatedAmountinteger required

Portion of the amount already allocated to invoice lines, in cents.

balanceinteger required

Unallocated remainder of the payment, in cents.

currencystring required

Three-letter ISO currency code.

paymentDatestring date-time required

When the payment was made.

paymentTypestring required

How the payment was made, e.g. creditCard, bankTransfer, ach, cash, or check.

statusstring required

Payment status: draft, posted, processing, requiresAction, failed, or canceled.

metadataobject nullable required

Key-value metadata stored on the payment.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.