GET /v1/payments/{id} endpoint returns a single payment record. You will receive a 403 if the payment exists but belongs to a different merchant, and a 404 if no record with that ID is found. This endpoint requires the donations:read permission on your API key.
Path parameters
string
required
The unique identifier of the payment to retrieve, for example
pay_01HXYZ1234ABCDEF.Response
On success the endpoint returns a single Payment object.string
required
Unique identifier for the payment.
string
required
Email address of the payer.
string
required
Payer’s first name.
string
required
Payer’s last name.
number
required
Payment amount in US dollars.
string
required
ISO 4217 currency code. Defaults to
USD.string
required
Payment status. One of:
COMPLETED, PENDING, FAILED, REFUNDED.string
required
Name of the fund designated by the payer.
string
required
Name of the donation form used to collect this payment.
string
required
Giving frequency. One of:
ONE_TIME, DAILY, WEEKLY, MONTHLY, ANNUALLY.string
required
ISO 8601 timestamp of when the payment was made.
string
required
Payment method used, such as
card or bank.boolean
required
Whether the payer elected to cover processing fees.
boolean
required
Whether the payer requested anonymity.
Response codes
Example
Response