Skip to main content
POST
/
charge-payments
List Charge Payment Attempts
curl --request POST \
  --url https://nestvet.com/api/1.1/wf/charge-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": "<string>",
  "limit": 123,
  "offset": 123,
  "charge": "<string>",
  "status": "Open",
  "created_at_since": "2023-11-07T05:31:56Z",
  "updated_at_since": "2023-11-07T05:31:56Z"
}
'
[
  {
    "id": "<string>",
    "currency": "<string>",
    "status": "Open",
    "amount": 123,
    "charge": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organization
string
required
limit
integer<int32>
required
offset
integer<int32>
required
charge
string
status
enum<string>
Available options:
Open,
Succeeded
created_at_since
string<date-time>
updated_at_since
string<date-time>

Response

200 - application/json

A list of charge payment attempts

id
string

This Charge Payment Attempt's unique id formatted as JSON-safe

currency
string

This Charge Payment Attempt's Currency is not empty formatted as text

status
enum<string>

This Charge Payment Attempt's Status's Display is empty formatted as text

Available options:
Open,
Succeeded
amount
number<double> | null

This Charge Payment Attempt's Amount formatted as 1028.58 defaulting to null

charge
string

This Charge Payment Attempt's Charge's unique id formatted as JSON-safe

created_at
string<date-time>

This Charge Payment Attempt's Creation Date formatted as 2026-01-12T15:18:23.660Z formatted as JSON-safe

updated_at
string<date-time>

This Charge Payment Attempt's Modified Date formatted as 2026-01-12T15:18:23.661Z formatted as JSON-safe