Payment Transactions
List Payment Transactions Endpoint
Trace Connect APIs
- Introduction
- Authentication using JWT
- OAuth 2.0
- Basic APIs
- Advanced APIs
- Accounts
- Catalogs
- Forms
- Supply Chain
- Product Transactions
- Payment Transactions
Payment Transactions
List Payment Transactions Endpoint
The List Payment Transactions endpoint allows users to retrieve a paginated list of payment transactions. Each transaction includes details such as transaction ID, premium details, currency details, transaction type, amount, invoice information, and other relevant details. Pagination information is provided in the response, allowing users to navigate through the transaction records.
GET
/
transactions
/
payment-transactions
curl --request GET \
--url http://localhost:3000/connect/v1/transactions/payment-transactions/ \
--header 'Authorization: <api-key>'
{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"premium_details": {
"id": "<string>",
"options": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"amount": 123,
"is_active": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"category": "PAYOUT",
"name": "<string>",
"type": "PER_TRANSACTION",
"amount": 123,
"included": true,
"dependant_on_card": true,
"applicable_activity": "BUY",
"calculation_type": "NORMAL",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
},
"currency_details": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
},
"type": "<string>",
"currency": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"number": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"date": "2023-11-07T05:31:56Z",
"invoice": "<string>",
"invoice_number": "<string>",
"verification_latitude": 123,
"verification_longitude": 123,
"method": "CARD",
"payment_type": "TRANSACTION",
"amount": 123,
"selected_option": "<string>",
"creator": "<string>",
"updater": "<string>",
"source": "<string>",
"destination": "<string>",
"card": "<string>",
"premium": "<string>",
"transaction": "<string>",
"submissions": [
"<string>"
]
}
]
}
Authorizations
Query Parameters
Number of results to return per page.
The initial index from which to return the results.
Response
200 - application/json
Required string length:
1 - 100
Required string length:
1 - 25
Available options:
PAYOUT
, TRANSACTION
Available options:
PER_TRANSACTION
, PER_KG
, PER_UNIT_CURRENCY
, PER_FARMER
Available options:
BUY
, SELL
Available options:
NORMAL
, MANUAL
, OPTIONS
Minimum length:
1
Maximum length:
10
Maximum length:
100
Available options:
CARD
, INVOICE
, NONE
Available options:
TRANSACTION
, PREMIUM
, TRANSACTION_PREMIUM
Maximum length:
100
curl --request GET \
--url http://localhost:3000/connect/v1/transactions/payment-transactions/ \
--header 'Authorization: <api-key>'
{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"premium_details": {
"id": "<string>",
"options": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"amount": 123,
"is_active": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"category": "PAYOUT",
"name": "<string>",
"type": "PER_TRANSACTION",
"amount": 123,
"included": true,
"dependant_on_card": true,
"applicable_activity": "BUY",
"calculation_type": "NORMAL",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
},
"currency_details": {
"id": "<string>",
"name": "<string>",
"code": "<string>"
},
"type": "<string>",
"currency": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"number": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"date": "2023-11-07T05:31:56Z",
"invoice": "<string>",
"invoice_number": "<string>",
"verification_latitude": 123,
"verification_longitude": 123,
"method": "CARD",
"payment_type": "TRANSACTION",
"amount": 123,
"selected_option": "<string>",
"creator": "<string>",
"updater": "<string>",
"source": "<string>",
"destination": "<string>",
"card": "<string>",
"premium": "<string>",
"transaction": "<string>",
"submissions": [
"<string>"
]
}
]
}