Skip to main content
GET
Get a payment

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

The payment id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successful response

Money a customer paid: how much, which customer, how much of it has been applied to invoices, and the fees charged against it, each itself a payment.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
type
enum<string>
required

How the payment reached you. CASH is money matched to a bank deposit and BANK_FEE is the fee a bank charged on one; PROCESSOR_FEE is what a payment provider took out of a sale, and every other value names the card network it came over.

Available options:
CASH,
BANK_FEE,
PROCESSOR_FEE,
VISA,
MASTERCARD,
AMEX,
DISCOVER,
CARD_OTHER,
ACH
parentPaymentId
string<uuid> | null
required

For a bank fee or a processor fee, the payment it was charged against; null for any other payment.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required

Whether the money for this payment has arrived. PENDING: the payment has been made but the money has not arrived yet. POSTED: the money has arrived. VOIDED: the payment provider declined, voided or let the payment expire, so the money will never arrive.

Available options:
PENDING,
POSTED,
VOIDED
receivedDate
string<date-time>
required

The day the payment was received. Only the date matters; the time is always midnight UTC.

customerId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
customerName
string | null
required
amount
object
required

The amount paid. Its value is a whole number of the currency's smallest unit, so { "value": 200000, "currencyCode": "USD" } is $2,000.00.

appliedAmount
object
required

How much of the payment has been applied to invoices.

unappliedAmount
object
required

How much of the payment is not yet applied to any invoice.

journalEntryId
string<uuid> | null
required

The journal entry the payment posted in; null while the payment is PENDING.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bankFee
any | null
required
deprecated

Deprecated: read fees.bank instead. The bank fee charged against this payment, itself a payment. A fee has none.

fees
object
required

The fees charged against this payment. A fee's own fees are both null.

createdAt
string
required
updatedAt
string
required