Skip to main content
The 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

​
id
string
required
The unique identifier of the payment to retrieve, for example pay_01HXYZ1234ABCDEF.

​
Response

On success the endpoint returns a single Payment object.
​
paymentID
string
required
Unique identifier for the payment.
​
email
string
required
Email address of the payer.
​
firstName
string
required
Payer’s first name.
​
lastName
string
required
Payer’s last name.
​
amount
number
required
Payment amount in US dollars.
​
currency
string
required
ISO 4217 currency code. Defaults to USD.
​
status
string
required
Payment status. One of: COMPLETED, PENDING, FAILED, REFUNDED.
​
fund
string
required
Name of the fund designated by the payer.
​
form
string
required
Name of the donation form used to collect this payment.
​
frequency
string
required
Giving frequency. One of: ONE_TIME, DAILY, WEEKLY, MONTHLY, ANNUALLY.
​
date
string
required
ISO 8601 timestamp of when the payment was made.
​
paymentMethod
string
required
Payment method used, such as card or bank.
​
coverFees
boolean
required
Whether the payer elected to cover processing fees.
​
anonymous
boolean
required
Whether the payer requested anonymity.

​
Response codes

CodeMeaning
200Payment found and returned.
403The payment belongs to a different merchant account.
404No payment with that ID exists.

​
Example

curl https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/payments/pay_01HXYZ1234ABCDEF \
  -H "Authorization: Bearer cs_live_your_key"
Response
{
  "paymentID": "pay_01HXYZ1234ABCDEF",
  "email": "jane.doe@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "amount": 100.00,
  "currency": "USD",
  "status": "COMPLETED",
  "fund": "General Fund",
  "form": "Annual Appeal",
  "frequency": "ONE_TIME",
  "date": "2025-04-15T14:32:00Z",
  "paymentMethod": "card",
  "coverFees": true,
  "anonymous": false
}