Charges
List Charges
Getting Started
Charges
List Charges
Retrieve a list of all charges.
GET
/
v1
/
charges
X-API-KEY
string
*
X-API-KEY
Required
string
Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings
page
integer
page
integer
A page number within the paginated result set.
page_size
integer
page_size
integer
Number of results to return per page.
search
string
search
string
search
Authorizations
Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings
Query Parameters
A page number within the paginated result set.
Number of results to return per page.
search
Response
200 - application/json
authorised- Authorisedcancelled- Cancelledcreated- Createddisputed- Disputedpaid- Paidrefunded- Refundedpartially_refunded- Partially refundedfailed- Failed
Available options:
authorised, cancelled, created, disputed, paid, refunded, partially_refunded, failed cash- cashnomod- nomodtabby- tabbytamara- tamara
Available options:
cash, nomod, tabby, tamara authorised- Authorisedauthorisation_cancelled- Cancelledauthorisation_captured- Capturedcreated- Createdcompleted- Paidcustomer_linked- Customer addedcustomer_unlinked- Customer removeddispute_lost- Dispute lostdispute_raised- Dispute raiseddispute_resolved- Dispute wonreceipt_sent- Receipt sentrefunded- Refundedpartially_refunded- Partially refundedfailed- Failed
Available options:
authorised, authorisation_cancelled, authorisation_captured, created, completed, customer_linked, customer_unlinked, dispute_lost, dispute_raised, dispute_resolved, receipt_sent, refunded, partially_refunded, failed