EZezypay

Retrieve a merchant

Changed on

Retrieve the business and address details of the respective merchant.

get/billing/merchant

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/merchant
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Headers

Authorizationstring
Merchantstring
Content-Typestring

Response

200

idstring
numberstring
legalNamestring
namestring
addressunknown
countryCodestring
emailstring
phoneNumberunknown
billingboolean
settlementboolean
statusstring
businessRegistrationNumberunknown
taxIdunknown
categoryCodeunknown
websiteunknown
descriptionunknown
referenceCodeunknown
acceptedPaymentMethodsstring[]
paymentReactivationHandlingstring
typestring
feePricingIdstring

Example response

{
  "id": "c556d40f-87b5-49f9-90e8-07a610dac1a7",
  "number": "57899",
  "legalName": "high_st LegalNameNZ",
  "name": "high_st NameNZ",
  "countryCode": "NZ",
  "email": "success+NZ+merchant+bf905c27-b03b-4529-a5d1-3beef14a03e3@simulator.amazonses.com",
  "billing": true,
  "settlement": true,
  "status": "ACTIVE",
  "settlementSchedule": {
    "intervalUnit": "DAY",
    "interval": 1,
    "nextSettlementDate": "2019-05-19",
    "intervalDayType": "calendar"
  },
  "settlementPayoutMethod": {
    "id": "c556d40f-87b5-49f9-90e8-07a610dac1a7",
    "paymentMethodToken": "cc0101ef-4bed-468a-8f0e-97449bba0edc",
    "bank": {
      "accountHolderName": "Automation Test NEW_ZEALAND",
      "last4": "0000",
      "bankNumber": "03",
      "branchNumber": "1587",
      "suffixNumber": "00"
    }
  },
  "acceptedPaymentMethods": [
    "BANK"
  ],
  "failedPaymentHandling": {
    "initialAction": "STOP",
    "autoRetry": true,
    "retryInDays": 3,
    "maximumFailedAttempts": 4
  },
  "paymentReactivationHandling": "activate_payments_across_customer",
  "notifications": {
    "customerEmail": {
      "subscriptionCreation": true,
      "paymentMethodCreation": true,
      "pastDueInvoice": true
    }
  },
  "metadata": {
    "ezypay_internal_payment_simulator": "false"
  },
  "type": "business",
  "feePricingId": "a67eca1d-0c37-4fc9-b9c5-03b2dc8aefc7",
  "documentNumberSettings": [
    {
      "documentType": "invoice",
      "prefix": "IN"
    }
  ]
}

Changes