Get payer by email

This endpoint enables you to retrieve the payer's details by using their email address.

GET: https://api.ompay.com/v1/merchants/YOUR_MERCHANT_ID/payer?email=EMAIL_ADDRESS

GET: https://api.sandbox.ompay.com/v1/merchants/YOUR_MERCHANT_ID/payer?email=EMAIL_ADDRESS

Request example

• Shell
• JavaScript

curl -X GET \
 https://api.ompay.com/v1/merchants/w3z8dfhkzvfq0j9n/payer?email=nazim@lamma.om \
  -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/payer?email=nazim@lamma.om");
xhr.setRequestHeader("authorization", "Basic ODZidWQ0Y2JremlxOXZmYzoweHI1ZDkwOHo2bmo4a2h6");

xhr.send();

Response example

{ 
        "payer_info": {
            "id": "0f053a05-9fa2-49a1-871f-3098e4b114e2",
            "email": "TomHanks@gmail.com",
            "name": "Tom Hanks",
            "billing_address": {
                "phone": {
                    "country_code": "230",
                    "number": "57976041"
                },
                "line1": "18 Avenue",
                "line2": "cassidy",
                "city": "Rose-Hill",
                "country_code": "MU",
                "postal_code": "72101",
                "state": ""
            }
        },
        "funding_instrument": {
            "credit_cards": [{
                "id": "9c22d208-4e25-47f8-8d32-c0e6d97c17c2",
                "type": "Visa",
                "expire_month": 12,
                "expire_year": 2020,
                "name": "Tom Hanks",
                "cvv_check": "Y",
                "avs_check": "S",
                "last4": "4821",
                "bin": "400552",
                "is_default": true,
                "bin_data": {
                    "bin": "400552",
                    "country_code": "MU",
                    "country_name": "Mauritius",
                    "bank_name": "MCB",
                    "card_scheme": "Visa",
                    "card_type": "Credit",
                    "card_category": "1"
                }
            }]
        }     
    }

Request

Header parameters

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