Loading...
Use this endpoint to retrieve transaction-level details for support and reconciliation purposes. Both Credit Sales and Credit Returns support the generating of a receipt when performing the GET request.
| Environment | Method | URL |
|---|---|---|
| Sandbox | GET | https://api.pit.paygateway.com/transactions/ |
| Production | GET | https://api.paygateway.com/transactions/ |
In order to perform a GET call on the relevant transaction type, you can use the ID assigned by the REST API or you can use the Reference ID you set in the transaction request. Regardless of which identifier you are using, the URL path will change based on the original transaction type
| Transaction Type | URL Type |
|---|---|
| Credit Sales | {base url}/creditsales/{creditsale_id} or {base url}/creditsales/reference_id/{reference_id} |
| Credit Returns | {base url}/creditreturns/{creditreturn_id} or {base url}/creditreturns/reference_id/{reference_id} |
| Debit Sales | {base url}/debitsales/{debitsale_id} or {base url}/debitsales/reference_id/{reference_id} |
| ACH/EFT Sales | {base url}/checksales/{checksale_id} or {base url}/checksales/reference_id/{reference_id} |
| Loan Sales | {base url}/loansales/{loansale_id} or {base url}/loansales/reference_id/{reference_id} |
| Loan Returns | {base url}/loanreturns/{loanreturn_id} or {base url}/loanreturns/reference_id/{reference_id} |
{
"amount": "9.27",
"transactions": [
{
"tender_type": "credit",
"transaction_datetime": "20230705042852",
"processor_response": "DEVELOPMENT APPROVAL",
"reference_id": "MER-5f604e28-d7f5-4c3c-a635-20635e1252f4",
"id": "000000000186",
"status": "approved",
"status_code": "200",
"credit_attributes": {
"payment": {
"amount": "9.27",
"type": "credit"
},
"approval_code": "333298",
"card": {
"masked_card_number": "476173XXXXXX0010",
"expiry_month": "12",
"expiry_year": "35",
"type": "visa"
}
}
}
]
}Report on ACH/EFT payments that were rejected by the bank (e.g., NSF, account closed, invalid account). Use it to identify failed items, see return reasons and dates, and trigger follow-ups like re-billing, updating bank details, or reversing ledger entries.
| Environment | Method | URL |
|---|---|---|
| Sandbox | GET | https://api.pit.paygateway.com/reports/returned_checks |
| Production | GET | https://api.paygateway.com/reports/returned_checks |
{
"report_id": "345",
"total_records": 15,
"total_pages": 10,
"current_page_size": 345,
"return_code": "R01",
"report": {
"records": [
{
"date": "2018-09-14",
"time": "2019-12-15T13:00:00Z",
"transaction_id": "000008639902",
"account_number": "001221111221",
"routing_number": "026009593",
"check_number": "121002048",
"amount": "23.09",
"return_date": "2018-09-14",
"return_code": "R01",
"return_message": "Check Returned"
}
]
}
}View processing and funding at the batch level using a GET call. Filter by date range, open a specific batch with batch_number, and retrieve Returned Checks and NOC (Notification of Change) reports. Designed for end-of-day reconciliation, deposit matching, and exception handling.
Supported types
| Environment | Method | URL |
|---|---|---|
| Sandbox | GET | https://api.pit.paygateway.com/reports/ |
| Production | GET | https://api.paygateway.com/reports/ |
Depending on whether you are looking to retrieve a list of batches or a single batch, you can use the following URL path.
| Batch Type | URL Type |
|---|---|
| Single Batch | {base url}/batches/{batch_number} |
| Multiple Batches | {base url}/batches |
{
"report_id": "345",
"total_records": 15,
"total_pages": 10,
"current_page_size": 345,
"processor_response": "APPROVAL ADB123",
"report": {
"records": [
{
"date": "2018-09-14",
"time": "2019-12-15T13:00:00Z",
"transaction_id": "000008639902",
"transaction_status": "approved",
"amount": "23.09",
"batch_number": "001333",
"user_id": "001246",
"transaction_type": "00",
"card_brand": "Visa",
"card_type": "Credit",
"cardholder_name": "Joe Doe",
"expiration_date": "35",
"account_number_source": "contactless",
"response_code": "7j",
"response_description": "string",
"processor_response": "APPROVAL ADB123",
"approval_code": "ADB123",
"avs_response_code": "A",
"cardsecurity_response_code": "M",
"invoice_number": "239087",
"customer": {
"title": "Mr.",
"first_name": "Joe",
"middle_name": "Henry",
"last_name": "Doe",
"business_name": "ABC Company LLC.",
"email": "joe.doe@gmail.com",
"phone": "345-090-2334",
"note": "This is a sample note",
"billing_address": {
"line1": "2600 NW",
"line2": "23th Street",
"city": "Lindon",
"state": "Utah",
"country": "USA",
"postal_code": "84042"
}
},
"shipping_address": {
"line1": "2600 NW",
"line2": "23th Street",
"city": "Lindon",
"state": "Utah",
"country": "USA",
"postal_code": "84042"
},
"ecommerce_indicator": "1",
"device_id": "123456890"
}
]
}
}{
"report_id": "345",
"total_records": 15,
"total_pages": 10,
"current_page_size": 345,
"processor_response": "APPROVAL ADB123",
"report": {
"records": [
{
"date": "2018-09-14",
"time": "2019-12-15T13:00:00Z",
"transaction_id": "000008639902",
"transaction_status": "approved",
"amount": "23.09",
"batch_number": "001333",
"user_id": "001246",
"transaction_type": "00",
"card_brand": "Visa",
"card_type": "Credit",
"cardholder_name": "Joe Doe",
"expiration_date": "35",
"account_number_source": "contactless",
"response_code": "Ia",
"response_description": "string",
"processor_response": "APPROVAL ADB123",
"approval_code": "ADB123",
"avs_response_code": "A",
"cardsecurity_response_code": "M",
"invoice_number": "239087",
"customer": {
"title": "Mr.",
"first_name": "Joe",
"middle_name": "Henry",
"last_name": "Doe",
"business_name": "ABC Company LLC.",
"email": "joe.doe@gmail.com",
"phone": "345-090-2334",
"note": "This is a sample note",
"billing_address": {
"line1": "2600 NW",
"line2": "23th Street",
"city": "Lindon",
"state": "Utah",
"country": "USA",
"postal_code": "84042"
}
},
"shipping_address": {
"line1": "2600 NW",
"line2": "23th Street",
"city": "Lindon",
"state": "Utah",
"country": "USA",
"postal_code": "84042"
},
"ecommerce_indicator": "1",
"device_id": "123456890"
}
]
}
}