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 bank fee charged on it, which is a payment of type BANK_FEE.

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

CASH for money received; BANK_FEE for the fee nested in a cash payment.

Available options:
CASH,
BANK_FEE
parentPaymentId
string<uuid> | null
required

For a bank fee, the cash payment it was charged against; null for a cash 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)$
receivedDate
string<date-time>
required

The calendar date the payment was received, carried at UTC midnight. The time is not data.

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
amountCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
appliedAmountCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
unappliedAmountCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
journalEntryId
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)$
bankFee
any | null
required

The bank fee charged against this payment, itself a payment. A fee has none.

createdAt
string
required
updatedAt
string
required