Retrieve Payment

This endpoint allows you to retrieve and view information and parameters related to a specific payment, using a payment ID

GET: https://api.ompay.com/v1/merchants/YOUR_MERCHANT_ID/payment/REFERENCE_ID

GET: https://api.sandbox.ompay.com/v1/merchants/YOUR_MERCHANT_ID/payment/REFERENCE_ID

Request example

• Shell
• JavaScript

curl -X GET \
 https://api.ompay.com/v1/merchants/w3z8dfhkzvfq0j9n/payment/W94Q5D31NWIRD90XYUI8 \
  -H 'authorization: Basic ODZidWQ0Y2JremlxOXZmYzoweHI1ZDkwOHo2bmo4a2h6' \
  -H 'content-type: application/json' 
}

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.ompay.com/v1/merchants/w3z8dfhkzvfq0j9n/payment/W94Q5D31NWIRD90XYUI8");
xhr.setRequestHeader("authorization", "Basic ODZidWQ0Y2JremlxOXZmYzoweHI1ZDkwOHo2bmo4a2h6");

xhr.send();

Response example

{
    "id": "w3z8dfhkzvfq0j9n",
    "reference_id": "w3z8dfhkzvfq0j9n",
    "state": "authorised",
    "result": {
        "authorisation_code": "110278",
        "code": "0000",
        "message": "Approved"
    },
    "intent": "Auth",
    "payer": {
        "payment_type": "CC",
        "funding_instrument": {
            "credit_card": {
                "id": "639b6999-f5cc-4f9c-951c-02a6d38a7994",
                "type": "Visa",
                "expire_month": 6,
                "expire_year": 2025,
                "name": "Avish Testing",
                "cvv_check": "Y",
                "avs_check": "S",
                "last4": "9996",
                "bin": "454347"
            }
        },
        "payer_info": {
            "id": "4b4ece0f-4dff-4f63-b39d-bc8bfbf636d7",
            "email": "sda@gmail.com",
            "ip": "",
            "name": "AvishTesting",
            "billing_address": {
                "phone": {
                    "country_code": "230",
                    "number": "57976041"
                },
                "line1": "18 Avenue",
                "line2": "cassidy",
                "city": "Rose-Hill",
                "country_code": "MU",
                "postal_code": "72101",
                "state": ""
            }
        }
    },
    "transaction": {
        "amount": {
            "currency": "USD",
            "total": "1"
        },
        "type": "1",
        "mode": "1",
        "soft_descriptor": {},
        "invoice_number": "123455"
    },
    "risk_check": true,
    "three_d": {},
    "create_time": "2023-09-05T10:18:45Z"
}

Request

Header parameters

The request require a Basic authentication in the header. For more information about HTTP request headers, see HTTP request headers.

Request parameters

Parameter	Type	Description
merchant_id required	string	Encrypted Merchant account identifier for the Merchant
reference_id required	string	Id of the initial transaction, usually this correspond to the authorisation ID.