API reference
Transactions API
Get all payments (paginated)
Optional URL Query Parameters:
- status (string): Status or a comma-separated list of statuses.
- pspReferenceId (string): The unique reference ID for the payment service provider.
- paymentMethod (string): Payment method or a comma-separated list of payment methods.
- source (string): Source or a comma-separated list of sources.
- shopperEmail (string): Shopper's email address.
- merchantAccountId (string): Selected merchant account id.
- organizationId (string): Selected organization id.
- startDate (string): Start date in 'y-MM-dd' format.
- endDate (string): End date in 'y-MM-dd' format, inclusive of the day.
- pageSize (number): Number of records to return, max 1000.
- pageIndex (number): Page index beginning with 0.
GET /api/v1/transactions
Response
{
"status": "ok",
"data": {
"rows": [
{
"createdAt": "2025-05-27T21:50:01.000Z",
"pspReferenceId": "ZNS6KG5CXZL3JM65",
"reference": "2RvOstypKrBgVMID",
"merchantAccount": {
"businessName": "Big Smile Boston",
"id": "MER4F5ZSPP48W",
"referenceId": null
},
"organization": {
"id": "bf368afb-ed57-4345-a04a-7c7213431a99",
"referenceId": null,
"name": "Big Smile LLC"
},
"authorizedAmount": 21200,
"paymentMethod": "mc",
"cardSummary": "0005",
"source": "ECOMMERCE",
"status": "SETTLED"
},
{
"createdAt": "2025-05-27T22:00:27.000Z",
"pspReferenceId": "X5N7KDMGPZBK6R65",
"reference": "C0CoRvLO7eFe67Lc",
"merchantAccount": {
"businessName": "Big Smile Boston",
"id": "MER4F5ZSPP48W",
"referenceId": null
},
"organization": {
"id": "bf368afb-ed57-4345-a04a-7c7213431a99",
"referenceId": null,
"name": "Big Smile LLC"
},
"authorizedAmount": 0,
"paymentMethod": "mc",
"cardSummary": "0005",
"source": "ECOMMERCE",
"status": "AUTHORIZED"
},
{
"createdAt": "2025-05-27T21:48:34.000Z",
"pspReferenceId": "N5C78NK78XLH5K75",
"reference": "B5lrmIRBsskGnJkJ",
"merchantAccount": {
"businessName": "Big Smile Boston",
"id": "MER4F5ZSPP48W",
"referenceId": null
},
"organization": {
"id": "bf368afb-ed57-4345-a04a-7c7213431a99",
"referenceId": null,
"name": "Big Smile LLC"
},
"authorizedAmount": 0,
"paymentMethod": "mc",
"cardSummary": "0005",
"source": "ECOMMERCE",
"status": "AUTHORIZED"
}
],
"pagination": {
"pageIndex": 0,
"pageSize": 3,
"pageCount": 34,
"total": 100,
"hasPrevPage": false,
"hasNextPage": true
}
}
}
Get a payment by PSP reference id
GET /api/v1/transactions/:pspReferenceId
Response
{
"status": "ok",
"data": {
"pspReferenceId": "xxx232",
"authorizedAmount": 24383,
"surchargeAmount": 488,
"refundedAmount": 0,
"merchantSplitAmount": 23408,
"tipAmount": null,
"currency": "USD",
"status": "DISPUTED",
"paymentMethod": "mc",
"paymentMethodVariant": "mcsuperpremiumdebit",
"cardSummary": "1226",
"splitSettingsFixed": 0,
"splitSettingsPercentage": 300,
"updatedAt": "2024-05-05T08:31:25.398Z",
"createdAt": "2024-05-05T08:31:25.398Z",
"reference": "cce9f7d6-f21f-45d1-b4a5-079cbf3581f2",
"merchantAccountId": "0f922ad3-a5ca-4213-9d1b-f943e95831c4",
"organizationId": "bf368afb-ed57-4345-a04a-7c7213431a99",
"source": "ECOMMERCE",
"merchantRefundedAmount": null,
"tenantRefundedAmount": null,
"merchantAccount": {
"businessName": "Big Smile Europe",
"splitConfigurationGroup": {
"refundSplitModel": "REVERSE_PAYMENT_SPLIT"
}
},
"organization": {
"name": "Big Smile LLC"
},
"checkout": {
"shopperId": null,
"shopperFirstName": null,
"shopperLastName": null,
"shopperEmail": "K-gk3DmjiJl-xABMFb23k@example.com",
"checkoutAttributes": [
{
"name": "INVOICE_ID",
"value": "rwR42JRurM_WLua4qxoi4"
}
]
},
"paymentEvents": [
{
"type": "SETTLEMENT",
"status": "SETTLED",
"amount": 24383,
"currency": "USD",
"pspReferenceId": "DNCUFNNV2JQACYE3",
"createdAt": "2024-05-05T08:31:25.398Z"
},
{
"type": "AUTHORIZATION",
"status": "AUTHORIZED",
"amount": 24383,
"currency": "USD",
"pspReferenceId": "DNCUFNNV2JQACYE3",
"createdAt": "2024-05-05T08:31:25.398Z"
}
]
}
}