Skip to main content
POST
List payment intents for the program

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

status_str
string

Filter by status value.

start_date
string<date-time>

Inclusive lower bound of a date/time range (ISO 8601).

end_date
string<date-time>

Inclusive upper bound of a date/time range (ISO 8601).

pi_action
enum<string>

Filter by payment intent action.

Available options:
instant,
approval_needed,
settlement_needed,
hold,
check
entity_type
enum<string>

Filter by the entity type the payment intent applies to.

Available options:
user,
business,
program

Free-text search filter. Matches common fields on the target collection.

payment_direction
enum<string>

Filter by transaction direction.

Available options:
credit,
debit
page
integer
default:1

Page number, 1-indexed. Defaults to 1 when omitted.

Required range: x >= 1
per_page
integer
default:10

Page size. Defaults to 10 when omitted.

Required range: 1 <= x <= 500

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.