Bank Account
- POSTValidate bank account and routing number
- GETGet all bank accounts for a user
- POSTAdd a new bank account for a user
- DELDelete a bank account
- GETGet Bank Account Balance
- GETGet bank account details
- POSTAdd bank account
- GETGet all bank accounts for a user
- POSTGet balance approval
- PUTSwitch default bank account
- POSTGet User Details by bank account
Business,Merchant
Refunds
Transaction
Webhook
Processor
Onboard Person
Get Transactions
Retrieve a list of transactions based on filter parameters
{
"status": true,
"message": "",
"data": {
"transactions": [
{
"data": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "ec82930a-b59e-4ed2-83dd-0f041bfa5baa",
"processor_mid": "123131123",
"transaction_status": "PAYOUT_COMPLETE",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"currency": "USD",
"amount": 57163,
"transaction_fee": 0,
"client_reference_id": "stageN5@123",
"payout_delay_days": 0,
"company_name": "Company-1",
"description": null,
"addenda": null,
"type": "api",
"ach_return_code": "R01",
"cancel_reason": null,
"spped": "sameday",
"failure_code": "R01",
"failure_reason": "Insufficient funds",
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": "9c33090b-c0fb-42ce-9ad8-921665d15a90",
"aggregator_type": "bank_link"
},
"payout_ach_return_code": "R01",
"payout_failure_reason": "Insufficient funds",
"vendor_name": "Vendor-1",
"trace_ids": {
"capture_trace_id": "ach_92lhg3vbf76qxzp",
"payout_trace_id": "ach_57ytkdw84mncxvq",
"reverse_payout_trace_id": "",
"refunds": [
{
"refund_uuid": "",
"refund_capture_trace_id": "",
"refund_payout_trace_id": ""
}
]
},
"created_at": "2024-06-03 15:58:44",
"updated_at": "2024-06-04 18:30:30"
}
}
]
},
"errors": null,
"error_code": null
}
Authorizations
Sanctum token-based authentication using the Bearer scheme.
Query Parameters
Number of records per page
Page number
Start date for filtering transactions
End date for filtering transactions
Sort order
newest
, oldest
UUID of the payer account
Aggregator type of the payer account (Required when payer_account_uuid is provided)
UUID of the payee account
Aggregator type of the payee account
Response
true
""
"9c330a70-84de-46c3-a380-70b34799b1d3"
"7d021f9a-b5f4-4668-8d78-0f448f55f984"
"ec82930a-b59e-4ed2-83dd-0f041bfa5baa"
"123131123"
"PAYOUT_COMPLETE"
"CAPTURE_COMPLETE"
"PAYOUT_COMPLETE"
null
null
"USD"
57163
0
"stageN5@123"
0
"Company-1"
null
null
"api"
"R01"
null
"sameday"
"R01"
"Insufficient funds"
"R01"
"Insufficient funds"
"Vendor-1"
"2024-06-03 15:58:44"
"2024-06-04 18:30:30"
null
null
{
"status": true,
"message": "",
"data": {
"transactions": [
{
"data": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "ec82930a-b59e-4ed2-83dd-0f041bfa5baa",
"processor_mid": "123131123",
"transaction_status": "PAYOUT_COMPLETE",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"currency": "USD",
"amount": 57163,
"transaction_fee": 0,
"client_reference_id": "stageN5@123",
"payout_delay_days": 0,
"company_name": "Company-1",
"description": null,
"addenda": null,
"type": "api",
"ach_return_code": "R01",
"cancel_reason": null,
"spped": "sameday",
"failure_code": "R01",
"failure_reason": "Insufficient funds",
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": "9c33090b-c0fb-42ce-9ad8-921665d15a90",
"aggregator_type": "bank_link"
},
"payout_ach_return_code": "R01",
"payout_failure_reason": "Insufficient funds",
"vendor_name": "Vendor-1",
"trace_ids": {
"capture_trace_id": "ach_92lhg3vbf76qxzp",
"payout_trace_id": "ach_57ytkdw84mncxvq",
"reverse_payout_trace_id": "",
"refunds": [
{
"refund_uuid": "",
"refund_capture_trace_id": "",
"refund_payout_trace_id": ""
}
]
},
"created_at": "2024-06-03 15:58:44",
"updated_at": "2024-06-04 18:30:30"
}
}
]
},
"errors": null,
"error_code": null
}