Query paymentRequests

get

https://api.swervepay.com/v/2.0/{accountSid}/paymentRequests

This is a resource for querying payment paymentRequests. The response will include a paymentRequestList of individual paymentRequest records.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountSid

string

required

length between 0 and 256

Account SID in my account

Query Params

afterId

string

length between 0 and 12

Include results with paymentRequestId greater than this value

beforeId

string

length between 0 and 12

Include results with paymentRequestId less than this value

count

string

length between 0 and 4

The number of results to return (default 10, max 1000)

createdDate

string

length between 0 and 19

Created Date

createdDateBefore

string

length between 0 and 19

Return payment requests created before this date/time. Expected date/timeformat is YYYY-MM-DD HH:MM:SS. The time requested is in GMT.

createdDateOnOrAfter

string

length between 0 and 19

Return payment requests created on or after this date/time. Expected date/timeformat is YYYY-MM-DD HH:MM:SS. The time requested is in GMT.

customerId

string

length between 0 and 12

Customer Id

maxId

string

length between 0 and 12

Include results with paymentRequestId less than or equal to this value

minId

string

length between 0 and 12

Include results with paymentRequestId greater or equal to this value

paymentRequestId

string

length between 0 and 12

Payment Request Id

sort

string

length between 0 and 21

Response list sort order

Valid Values:

paymentRequestId_asc, paymentRequestId_desc

paymentRequestId_asc: Sort by paymentRequestId in ascending order

paymentRequestId_desc: (Default) Sort by paymentRequestId in descendingorder

status

string

length between 0 and 12

Payment Request Status

Valid Values:

canceled, open, expired, completed

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unvailable

504

Gateway Timeout

200OK

400Bad Request