API Reference
GENERIC connector API (v0.1)
Download OpenAPI specification:Download
Get all accounts
query Parameters
pageSize | integer <int64> >= 1 Default: 100 Example: pageSize=100 Number of items per page |
page | integer <int64> >= 1 Default: 1 Example: page=1 Page number |
sort | string Example: sort=createdAt:asc Sort order |
createdAtFrom | string <date-time> Filter by created at date |
Responses
Response samples
- 200
- default
Content type
application/json
[- {
- "id": "string",
- "accountName": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Get all beneficiaries
query Parameters
pageSize | integer <int64> >= 1 Default: 100 Example: pageSize=100 Number of items per page |
page | integer <int64> >= 1 Default: 1 Example: page=1 Page number |
sort | string Example: sort=createdAt:asc Sort order |
createdAtFrom | string <date-time> Filter by created at date |
Responses
Response samples
- 200
- default
Content type
application/json
[- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "ownerName": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Get all transactions
query Parameters
pageSize | integer <int64> >= 1 Default: 100 Example: pageSize=100 Number of items per page |
page | integer <int64> >= 1 Default: 1 Example: page=1 Page number |
sort | string Example: sort=createdAt:asc Sort order |
updatedAtFrom | string <date-time> Filter by updated at date |
Responses
Response samples
- 200
- default
Content type
application/json
[- {
- "id": "string",
- "relatedTransactionID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "scheme": "string",
- "type": "PAYIN",
- "status": "PENDING",
- "amount": "string",
- "sourceAccountID": "string",
- "destinationAccountID": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]