List all Transactions
GET https://gateway-api.paycertify.com/api/transactions
In order to list all the transactions that have been sent through the gateway, you can use this endpoint. Please note that for every new event that is sent under the same transaction, the transaction’s updated_at
field is updated.
Filtering is enabled to this endpoint through query parameter search
. So whenever searching for a field, make sure to submit it through the endpoint’s query parameters, for example: https://gateway-api.paycertify.com/api/transactions?search[first_name]=John&search[last_name]=Doe. Filter types are described below:
starts with
which matches for records on a SQLLIKE
fashion, e.g.: a string “PayC” will match “PayCertify”;exact comparison
which matches for records through exact comparison, case sensitive, e.g.: a string “Paycertify” will NOT match “PayCertify”;date
which matches for records through SQL date, and these fields should be provided on Y-m-d H:i:s format, e.g.: 2025-01-01 17:59:00
Also, this endpoint provides pagination to navigate through record sets. Pagination information can be found on meta
response field. The pages always return 50 records at a time. While using reporting capabilities, make sure to monitor rate limits through X-RateLimit-Limit
and X-RateLimit-Remaining
response headers.
Parameter | Type | Length | Presence | Filter Type |
---|---|---|---|---|
merchant_transaction_id |
string |
1-255 | Optional | starts with |
card_number [1] |
string |
8-19 | Optional | starts with |
first_name |
string |
1-255 | Optional | starts with |
last_name |
string |
1-255 | Optional | starts with |
email |
string |
1-255 | Optional | starts with |
mobile_phone |
string |
11-15 | Optional | starts with |
user_id |
string |
36 | Optional | exact comparison |
city |
string |
1-255 | Optional | starts with |
state |
string |
2 | Optional | exact comparison |
zip |
string |
5 | Optional | exact comparison |
shipping_city |
string |
1-255 | Optional | starts with |
shipping_state |
string |
2 | Optional | exact comparison |
shipping_zip |
string |
5 | Optional | exact comparison |
created_at_gte |
datetime |
19 | Optional | date |
created_at_lte |
datetime |
19 | Optional | date |
updated_at_gte |
datetime |
19 | Optional | date |
updated_at_lte |
datetime |
19 | Optional | date |
[1] Please note that whenever searching for card numbers, you should only search by the first six digits, fill with 8 asterisks
Parameter | Type | Length | Description | Example |
---|---|---|---|---|
transactions.*.id |
uuid |
36 | This transaction’s ID | 41f00869-d7b3-413e-9476-9ef1a8bc2f28 |
transactions.*.merchant_id |
uuid |
36 | The user’s merchant ID | 41f00869-d7b3-413e-9476-9ef1a8bc2f28 |
transactions.*.user_id |
uuid |
36 | The user’s ID | 41f00869-d7b3-413e-9476-9ef1a8bc2f28 |
transactions.*.processor_id |
uuid |
36 | The processor’s ID | 41f00869-d7b3-413e-9476-9ef1a8bc2f28 |
transactions.*.merchant_transaction_id |
string |
1-255 | The merchant assigned identifier | my-order-id-0001 |
transactions.*.updated_at |
datetime |
- | Last time this transaction was updated, on ISO 8601 UTC | 2018-02-16T16:33:40+00:00 |
trqnsactions.*.created_at |
datetime |
- | Time that transaction was created, on ISO 8601 UTC | 2018-02-16T16:33:40+00:00 |
transactions.*.events.*.id |
uuid |
36 | This event’s ID | 41f00869-d7b3-413e-9476-9ef1a8bc2f28 |
transactions.*.events.*.success |
boolean |
- | If the event was a successful event or not | true |
transactions.*.events.*.event_type |
string |
4-10 | The type of event being performed | auth, capture, sale, void, refund |
transactions.*.events.*.amount |
number |
0.01-9999999 | Total event amount | 3.56 |
transactions.*.events.*.processor_code |
string |
2-10 | The processor response code | 00 |
transactions.*.events.*.processor_message |
string |
1-255 | A human readable message from the processor | APPROVAL V12341 |
transactions.*.events.*.processor_transaction_id |
string |
1-255 | A processor assigned identifier | 00000000143242 |
transactions.*.events.*.updated_at |
datetime |
- | Last time this event was updated, on ISO 8601 UTC | 2018-02-16T16:33:40+00:00 |
transactions.*.events.*.created_at |
datetime |
- | Time that event was created, on ISO 8601 UTC | 2018-02-16T16:33:40+00:00 |
meta.last_page |
number |
- | The last page for this query | 1 |
meta.current_page |
number |
- | The current page for this query | 1 |
meta.total |
number |
- | The total count of records for this page | 1 |
curl --request GET \
--url 'https://gateway-api.paycertify.com/api/transactions?search[first_name]=John&search[last_name]=Doe' \
--header 'Authorization: Bearer EE9DC8DB823EF153186B9B3F2702DE378ACC2254' \
--header 'Cache-Control: no-cache'
Responds with:
{
"transactions": [
{
"id": "3410596f-d596-42d4-9811-41d43868e984",
"merchant_id": "455a1c64-385b-41b2-a56f-34bf6c5c5335",
"user_id": "6e064bf5-0e18-466b-811b-f967e8d73b9f",
"processor_id": "30ff7682-6ec7-48f3-8d7a-62319a9c3c59",
"merchant_transaction_id": "my-order-id-0001",
"card_number": "411111******1111",
"card_brand": "visa",
"card_expiry_month": "01",
"card_expiry_year": "2021",
"first_name": "John",
"last_name": "Doe",
"street_address_1": "59 N Santa Cruz Avenue",
"street_address_2": "Suite M",
"city": "Los Gatos",
"state": "CA",
"country": "US",
"zip": "95030",
"email": "[email protected]",
"mobile_phone": "+11231231234",
"updated_at": "2018-02-16T16:33:40+00:00",
"created_at": "2018-02-16T16:33:39+00:00",
"events": [
{
"id": "84a8ab86-ee0e-47d4-8686-4e42fa58355e",
"success": true,
"threeds_response": null,
"avs_response": null,
"event_type": "sale",
"amount": "1.00",
"ip_address": "127.0.0.1",
"processor_code": "00",
"processor_message": "APPROVAL TAS656 ",
"processor_transaction_id": "000000000252616",
"processor_threeds_response": null,
"processor_avs_response": "0",
"updated_at": "2018-02-16T16:33:40+00:00",
"created_at": "2018-02-16T16:33:39+00:00"
}
]
},
{
"id": "93174e5d-79dd-4fa5-b817-ac366c37e524",
"merchant_id": "455a1c64-385b-41b2-a56f-34bf6c5c5335",
"user_id": "6e064bf5-0e18-466b-811b-f967e8d73b9f",
"processor_id": "30ff7682-6ec7-48f3-8d7a-62319a9c3c59",
"merchant_transaction_id": "my-order-id-0001",
"card_number": "411111******1111",
"card_brand": "visa",
"card_expiry_month": "01",
"card_expiry_year": "2021",
"first_name": "John",
"last_name": "Doe",
"street_address_1": "59 N Santa Cruz Avenue",
"street_address_2": "Suite M",
"city": "Los Gatos",
"state": "CA",
"country": "US",
"zip": "95030",
"email": "[email protected]",
"mobile_phone": "+11231231234",
"updated_at": "2018-02-16T16:33:32+00:00",
"created_at": "2018-02-16T16:33:29+00:00",
"events": [
{
"id": "8525c0c9-f05f-4199-9646-e413728c57a0",
"success": false,
"threeds_response": null,
"avs_response": null,
"event_type": "sale",
"amount": "1.00",
"ip_address": "127.0.0.1",
"processor_code": "N7",
"processor_message": "CVV2 MISMATCH ",
"processor_transaction_id": "000000000252613",
"processor_threeds_response": null,
"processor_avs_response": "0",
"updated_at": "2018-02-16T16:33:32+00:00",
"created_at": "2018-02-16T16:33:29+00:00"
}
]
}
],
"meta": {
"last_page": 1,
"current_page": 1,
"total": 2
}
}