Skip to main content
GET
/
3p
/
api
/
v2
/
transactions
Get Transactions ( STABLE )
curl --request GET \
  --url https://api.grailpay.com/3p/api/v2/transactions \
  --header 'Authorization: Bearer <token>'
{
  "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

​
Authorization
string
header
required

Sanctum token-based authentication using the Bearer scheme. This is provided by the GrailPay Customer Support Team

Query Parameters

​
per_page
integer

Number of records per page

​
page
integer

Page number

​
start_date
string<date>

Start date for filtering transactions

​
end_date
string<date>

End date for filtering transactions

​
sort_order
enum<string>

Sort order

Available options:
newest,
oldest
​
payer_account_uuid
string<uuid>

UUID of the payer account

​
payer_account_aggregator_type
string

Aggregator type of the payer account (Required when payer_account_uuid is provided)

​
payee_account_uuid
string<uuid>

UUID of the payee account

​
payee_account_aggregator_type
string

Aggregator type of the payee account

Response

List of transactions

​
status
boolean
Example:

true

​
message
string
Example:

""

​
data
object
​
errors
string
Example:

null

​
error_code
string
Example:

null