Loading...
Important: For authentication, you must include the required HTTPS headers in each request. For more information about the authentication HTTPS headers, see Authenticating Your Requests.
To view the details of a credit sale, send a GET request including either the debitreturn_id or the reference_id to the relevant endpoint.
Important: To generate a receipt, include the generate_receipt parameter in the URL and set the value to true.
https://api.paygateway.com/transactions/debitreturns/000008639902?generate_receipt=trueThe endpoint you use depends on whether you identify the sale using the debitreturn_id (generated by the gateway) or the reference_id (generated by the merchant's POS).
| Environment | HTTP Method | URL |
|---|---|---|
| Partner Integration Test | GET | https://api.pit.paygateway.com/transactions/debitreturns/{debitreturn_id} |
| Production | GET | https://api.paygateway.com/transactions/debitreturns/{debitreturn_id} |
| Environment | HTTP Method | URL |
|---|---|---|
| Partner Integration Test | GET | https://api.pit.paygateway.com/transactions/debitreturns/reference_id/{reference_id} |
| Production | GET | https://api.paygateway.com/transactions/debitreturns/reference_id/{reference_id} |
GET /transactions/debitreturns/0000012345678903266{
"debitreturn_id": "0000012345678903266",
"reference_id": "XAZR863990",
"status": "approved",
"approval_code": "ADB123",
"debit_card": {
"masked_card_number": "XXXXXXXXXXX5538",
"expiry_month": "03",
"expiry_year": "23",
"type": "visa"
},
"payment": {
"amount": "23.09",
"cashback_amount": "10.00",
"invoice_number": "239087",
"type": "credit"
},
"transaction": {
"batch_amount": "12.09",
"batch_number": "001333",
"entry_type": "contactless",
"tracking_id": "TrackingID123"
},
"receipt": {
"id": "72845",
"text": {
"customer_receipt": "\\nBatch # 000161\\nTrans ID 000000141687\\nOrder ID PAYAPIa0155b35-420c-\\n 46a5-9b0a-f01ac0004a\\n 76\\nReceipt # 123456890\\nTrans Type Return\\nClerk ID Al090\\nDate/Time 2018-12-10 21:56:16\\nCard Type Visa\\nCard Number XXXXXXXXXXXX2222\\nEntry Legend MAG STRIPE\\nEntry Method CONTACTLESS\\nApproval Code 577279\\n\\nTotal Amount USD$132.00\\n\\n Approved - Thank You\\n\\n X____________________________________\\n Signature: Joe Doe\\n\\n ****Customer Copy****\\n Retain this copy for statement\\n verification",
"merchant_receipt": "\\nBatch # 000161\\nTrans ID 000000141687\\nOrder ID PAYAPIa0155b35-420c-\\n 46a5-9b0a-f01ac0004a\\n 76\\nReceipt # 123456890\\nTrans Type Return\\nClerk ID Al090\\nDate/Time 2018-12-10 21:56:16\\nCard Type Visa\\nCard Number XXXXXXXXXXXX2222\\nEntry Legend MAG STRIPE\\nEntry Method CONTACTLESS\\nApproval Code 577279\\n\\nTotal Amount USD$132.00\\n\\n Approved - Thank You\\n\\n X____________________________________\\n Signature: Joe Doe\\n\\n ****Merchant Copy****"
},
"attributes": {
"authorization_agreement": "I agree to pay above total amount according to card issuer agreement",
"call_issuer": "CALL ISSUER",
"copy_label_customer": "****Customer Copy**** Retain this copy for statement verification",
"copy_label_merchant": "MERCHANT COPY",
"merchant_address": "2578 West 600 North",
"merchant_footer": "Thank you. Come again.",
"merchant_header": "ABC Grocery",
"merchant_name": "ABC Stores",
"merchant_phone": "901-492-7269",
"merchant_policy": "Generally, merchandise purchased in store or online can be returned or exchanged within ninety (90) days of purchase with or without a receipt",
"pin_verification_text": "",
"verbiage": "Approved - Thank You"
},
"labeled_attributes": {
"approval_code": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"amount": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"application_cryptogram": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"application_identifier": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"application_label": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"application_preferred_name": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"application_transaction_counter": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"authorization_response_code": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"avs_response_code": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"batch_number": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"card_balance": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"card_type": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"cardsecurity_response_code": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"clerk_id": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"emv_tags": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"entry_legend": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"entry_method": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"gratuity_amount": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"masked_card_number": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"merchant_id": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"original_auth_code": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"payment_type": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"number": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"reference_id": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"sequence_number": {
"label": "Total Amount",
"value": "Total Amount"
},
"subtotal_amount": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"tax_amount": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"terminal_verification_results": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"total_amount": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"transaction_datetime": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"transaction_id": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"transaction_reference_number": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"transaction_status_information": {
"label": "Total Amount",
"value": "Total Amount"
},
"transaction_type": {
"label": "Total Amount",
"value": "$99.45 USD"
},
"validation_code": {
"label": "Total Amount",
"value": "$99.45 USD"
}
}
},
"links": [
{
"debitreturn_id": [
{
"href": "https://api.paygateway.com/cnp-payments/sales/000000106821",
"relation": "self",
"method": "POST",
"description": "Use this endpoint to retrieve a previous sales transaction using reference id."
}
],
"reference_id": [
{
"href": "https://api.paygateway.com/cnp-payments/sales/000000106821",
"relation": "self",
"method": "POST",
"description": "Use this endpoint to retrieve a previous sales transaction using reference id."
}
]
}
]
}