Merchant Profile

View Merchant Profile

Your merchant profile contains important information for how your merchant has been set up with Wpay and provides details that can be utilised in subsequent service calls meaning you don't need to store the information if you do not wish to.

curl --location \
--request GET 'https://{{environment}}-api.wpay.com.au/wow/v1/pay/merchants/profile' \
--header 'accept: application/json' \
--header 'X-Api-Key: {{yourApiKey}}' \
var myHeaders = new Headers();
var yourAPIkey = "YOUR-API-KEY";
myHeaders.append("accept", "application/json");
myHeaders.append("X-Api-Key", yourAPIkey);
myHeaders.append("X-Message-Id", "bab748f9-dd67-4d9f-a6d5-4d891d0b0ae7");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

var environment = "substitute environment-value here"
fetch(`https://${environment}-api.wpay.com.au/wow/v1/pay/merchants/profile`, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Merchant Profile Outcome

Your currently configured merchant profile with Wpay will be returned showing important information such as:

  • Allowed payment methods showing which payment methods are currently configured including additional details such as the allowed bins for gift cards and the allowed networks for credit cards.
  • Token and key data for 3rd party payment providers such as PayPal.
{
  "allowedPaymentMethods": {
    "giftCard": {
      "allowedBins": [
        "600300",
        "628000"
      ],
      "serviceStatus": "ENABLED",
      "pinAlwaysRequired": false
    },
    "creditCard": {
      "allowedNetworks": [
        "AMEX",
        "MASTERCARD",
        "JCB",
        "VISA",
        "DINERS"
      ],
      "allowedTransactionTypes": [
        "PREAUTH",
        "PURCHASE"
      ],
      "serviceStatus": "ENABLED"
    },
    "payPal": {
      "clientToken": "ey*************************em=",
      "serviceStatus": "ENABLED"
    },
    "googlePay": {
      "publicKey": null,
      "publicKeyHash": null,
      "publicKeyExpiry": null,
      "merchantId": "11111",
      "merchantName": "Test Merchant",
      "creditCard": {
        "allowedNetworks": [
          "AMEX",
          "MASTERCARD",
          "VISA"
        ],
        "allowedTransactionTypes": [
          "PURCHASE",
          "PREAUTH"
        ]
      },
      "debitCard": {
        "allowedNetworks": [],
        "allowedTransactionTypes": [
          "PURCHASE",
          "PREAUTH"
        ]
      },
      "serviceStatus": "ENABLED"
    },
    "applePay": {
      "creditCard": {
        "allowedNetworks": [
          "AMEX",
          "MASTERCARD",
          "VISA"
        ],
        "allowedTransactionTypes": [
          "PREAUTH",
          "PURCHASE"
        ]
      },
      "debitCard": {
        "allowedNetworks": [],
        "allowedTransactionTypes": [
          "PREAUTH",
          "PURCHASE"
        ]
      },
      "serviceStatus": "ENABLED"
    },
    "paymentAgreement": {
      "allowedInstrumentTypes": [
        "CREDIT_CARD",
        "PAYPAL"
      ],
      "serviceStatus": "ENABLED"
    }
  }
}