Get all transactions
Authentication Route
This route is secured with processor and vendor token authentication.
Endpoint
/3p/api/v2/transactions
Request Payload
{
"pageSize": 10,
"page": 1,
"startDate": "2023-12-12",
"endDate": "2023-12-30",
"payer_account_uuid": "f1ad9d49-62fe-4a28-8873-11f220bb023d",
"payer_account_aggregator_type": "manual",
"payee_account_uuid": "7b8f02a2-ff93-4db8-874d-c949a5a81f46",
"payee_account_aggregator_type": "bank_link"
}
| Fields | Type | Is Required | Description |
|---|---|---|---|
| per_page | integer | No | By default: 10 Min: 1 Max: 100 |
| page | int | No | |
| start_date | string | No | This parameter will filter the transaction's records based on the creation date of the transaction. Date format: Y-m-d |
| end_date | string | No | This parameter will filter the transaction's records based on the creation date of the transaction. Date format: Y-m-d |
| sort_order | string | No | By default: newest Possible Value: newest oldest |
| payer_account_uuid | string|uuid | Payer bank account uuid Required when payer_account_aggregator_type exists | |
| payer_account_aggregator_type | string | Payer bank account type Required when payer_account_uuid exists | |
| payee_account_uuid | string|uuid | Payee bank account uuid Required when payee_account_aggregator_type exists | |
| payee_account_aggregator_type | string | Payee bank account type Required when payee_account_uuid exists |
Response Object
{
"status": true,
"message": "",
"data": {
"transactions": [
{
"uuid": "9c352cfb-55aa-4f17-8e38-354929b5fbf6",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "76c08e55-48e1-4f4c-9299-52c93d6546d1",
"transaction_status": "IN_PAYOUT",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"currency": "USD",
"amount": 33462,
"transaction_fee": 0,
"client_reference_id": "QA@123",
"payout_delay_days": 0,
"company_name": "John Corporation",
"description": null,
"addenda": null,
"type": "api",
"ach_return_code": null,
"failure_code": null,
"failure_reason": null,
"cancel_reason": null,
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": null,
"aggregator_type": null
},
"vendor_name": "John Corporation",
"created_at": "2024-06-04 17:26:58",
"updated_at": "2024-06-05 12:30:17"
},
{
"uuid": "9c352d10-8116-4cb6-8028-836bc1cd31a0",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "76c08e55-48e1-4f4c-9299-52c93d6546d1",
"transaction_status": "IN_PAYOUT",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"currency": "USD",
"amount": 33462,
"transaction_fee": 0,
"client_reference_id": "QA@123",
"payout_delay_days": 0,
"company_name": "John Corporation",
"description": null,
"addenda": null,
"type": "api",
"ach_return_code": null,
"failure_code": null,
"failure_reason": null,
"cancel_reason": null,
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": null,
"aggregator_type": null
},
"vendor_name": "John Corporation",
"created_at": "2024-06-04 17:27:12",
"updated_at": "2024-06-05 12:30:17"
},
{
"uuid": "9c352d63-ee02-4b72-9ced-1edd74858d2d",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "76c08e55-48e1-4f4c-9299-52c93d6546d1",
"transaction_status": "IN_PAYOUT",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"currency": "USD",
"amount": 1533462,
"transaction_fee": 0,
"client_reference_id": "QA@123",
"payout_delay_days": 0,
"company_name": "John Corporation",
"description": null,
"addenda": null,
"type": "api",
"ach_return_code": null,
"failure_code": null,
"failure_reason": null,
"cancel_reason": null,
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": null,
"aggregator_type": null
},
"vendor_name": "John Corporation",
"created_at": "2024-06-04 17:28:07",
"updated_at": "2024-06-05 12:30:17"
}
],
"pagination": {
"totalItems": 53,
"pageSize": 10,
"currentPage": 6,
"totalPages": 6
}
},
"errors": null,
"error_code": null
}
Errors & Warnings
| Code | Message |
|---|---|
| 401 | |
| 403 | |
| 422 |
Updated 15 days ago