API reference
Every endpoint in the StrideHQ API, grouped by resource. Each page shows the endpoint's parameters, an example request in Shell, Node and Python, and an example response.
Organisation
- Get your organisation:
GET /organisation
Creators
- List creators:
GET /creators - Create a creator:
POST /creators - Search creators:
GET /creators/search - Get a creator:
GET /creators/{id} - Update a creator:
PATCH /creators/{id}
Invoices
- List invoices:
GET /invoices - Submit an invoice:
POST /invoices - Get an invoice:
GET /invoices/{id} - Update an invoice:
PATCH /invoices/{id} - Get the invoice file:
GET /invoices/{id}/file
Purchase orders
- List purchase orders:
GET /purchase_orders - Get a purchase order:
GET /purchase_orders/{id}
Payment runs
- List payment runs:
GET /payment_runs - Prepare a payment run:
POST /payment_runs - Get a payment run:
GET /payment_runs/{id} - Withdraw a payment run:
POST /payment_runs/{id}/withdraw - Get remittance advice:
GET /payment_runs/{id}/remittance_advice
Payments
- List payments:
GET /payments - Get a payment:
GET /payments/{id}
Webhooks
- List webhook endpoints:
GET /webhook_endpoints - Create a webhook endpoint:
POST /webhook_endpoints - Get a webhook endpoint:
GET /webhook_endpoints/{id} - Update a webhook endpoint:
PATCH /webhook_endpoints/{id} - Delete a webhook endpoint:
DELETE /webhook_endpoints/{id} - Send a test event:
POST /webhook_endpoints/{id}/test
Events
- List events:
GET /events - Get an event:
GET /events/{id} - Resend an event:
POST /events/{id}/resend
Reference data
- List currencies:
GET /reference/currencies - List countries:
GET /reference/countries
Sandbox test helpers
- Approve a run:
POST /test_helpers/payment_runs/{id}/approve - Fund a run:
POST /test_helpers/payment_runs/{id}/fund - Complete a run:
POST /test_helpers/payment_runs/{id}/complete - Fail a run:
POST /test_helpers/payment_runs/{id}/fail - Fail a payment:
POST /test_helpers/payments/{id}/fail