Payments API
Payments API (1.0.0)
Download OpenAPI specification:Download
Returns a list of payments.
query Parameters
limit | integer Example: limit=10 Limit the number of payments to return, pagination can be achieved in conjunction with 'skip' parameter. |
skip | integer Example: skip=100 How many payments to skip, pagination can be achieved in conjunction with 'limit' parameter. |
sort | Array of strings Example: sort=status Field used to sort payments (Default is by date). |
Responses
Response samples
- 200
Content type
application/json
{- "data": [
- {
- "provider": "string",
- "reference": "string",
- "scheme": "visa",
- "status": "string",
- "type": "pay-in",
- "id": "XXX",
- "amount": 100,
- "asset": "USD",
- "date": "2019-08-24T14:15:22Z",
- "raw": null
}
]
}
Response samples
- 200
Content type
application/json
{- "provider": "string",
- "reference": "string",
- "scheme": "visa",
- "status": "string",
- "type": "pay-in",
- "id": "XXX",
- "amount": 100,
- "asset": "USD",
- "date": "2019-08-24T14:15:22Z",
- "raw": null
}
Install connector
Install connector
path Parameters
connector required | string Value: "stripe" The connector code |
Request Body schema: application/json
One of
pollingPeriod | string Default: "120s" The frequency at which the connector will try to fetch new BalanceTransaction objects from Stripe api |
apiKey required | string |
pageSize | number Default: 10 Number of BalanceTransaction to fetch at each polling interval. |
Responses
Request samples
- Payload
Content type
application/json
{- "pollingPeriod": "60s",
- "apiKey": "XXX",
- "pageSize": 50
}
List connector tasks
List all tasks associated with this connector.
path Parameters
connector required | string Value: "stripe" The connector code |
Responses
Response samples
- 200
Content type
application/json
[- {
- "oldestId": "string",
- "oldestDate": "2019-08-24T14:15:22Z",
- "moreRecentId": "string",
- "moreRecentDate": "2019-08-24T14:15:22Z",
- "noMoreHistory": true
}
]
Read a specific task of the connector
Get a specific task associated to the connector
path Parameters
connector required | string Value: "stripe" The connector code |
taskId required | string Example: task1 The task id |
Responses
Response samples
- 200
Content type
application/json
{- "oldestId": "string",
- "oldestDate": "2019-08-24T14:15:22Z",
- "moreRecentId": "string",
- "moreRecentDate": "2019-08-24T14:15:22Z",
- "noMoreHistory": true
}