Every endpoint in Collections: 8 operations across 5 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Gateways
GET/api/collect/gateways
List gateways
curl -X GET https://app.jaicrm.ai/api/collect/gateways
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/collect/gateways/{gateway}/test
Create a test
| Parameter | Type | Required | Notes |
|---|---|---|---|
gateway | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/collect/gateways/RECORD_ID/test
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/collect/gateways/{gateway}
Change a gateway
| Parameter | Type | Required | Notes |
|---|---|---|---|
gateway | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/collect/gateways/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/collect/gateways/{gateway}
Delete a gateway
| Parameter | Type | Required | Notes |
|---|---|---|---|
gateway | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/collect/gateways/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Attempts
GET/api/collect/attempts
List attempts
curl -X GET https://app.jaicrm.ai/api/collect/attempts
-H 'Authorization: Bearer YOUR_API_KEY'Pay
POST/api/collect/pay/{token}
Act on a pay
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/collect/pay/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Options
GET/api/collect/options/{token}
Read one option
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/collect/options/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Webhook
POST/api/collect/webhook/{tenantId}/{gateway}
Act on a webhook
| Parameter | Type | Required | Notes |
|---|---|---|---|
tenantId | string | Required | The record’s id. |
gateway | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/collect/webhook/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.