List payments
List all the payments made towards an invoice.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/invoices.read scope.
GET
/accounts/{accountID}/invoices/{invoiceID}/payments
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
[
{
"amount": {
"currency": "USD",
"valueDecimal": "500.00"
},
"invoicePaymentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"invoicePaymentType": "transfer",
"transfer": {
"transferID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
}
},
{
"amount": {
"currency": "USD",
"valueDecimal": "500.00"
},
"external": {
"description": "Payment via external system",
"foreignID": "EXT-PAY-12345",
"paymentDate": "2026-01-20T14:45:00Z"
},
"invoicePaymentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"invoicePaymentType": "external"
}
]Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
X-Moov-Version
string
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
When no version is specified, the API defaults to v2024.01.00.
Path parameters
accountID
string
<uuid>
required
invoiceID
string
<uuid>
required
Response
amount
object
Show child attributes
currency
string
required
Pattern
A 3-letter ISO 4217 currency code.
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
external
object
Show child attributes
description
string
foreignID
string
paymentDate
string<date-time>
invoicePaymentID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
invoicePaymentType
string<enum>
Possible values:
transfer,
external
transfer
object
Show child attributes
transferID
string
<=36 characters
required
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).