EZezypay

Create a payment method

Changed on

Links a new payment method token to an existing customer. If the customer has no primary payment method specified, then the new token will become the primary payment method by default. No verification is performed during the linking of payment method.

post/billing/customers/{customerId}/paymentmethods

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/customers/{customerId}/paymentmethods
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

customerIdstring required

Auto-generated unique identifier of the customer that will be associated with the payment method token.

Headers

merchantstring required

Merchant ID

Request body

paymentMethodTokenstring required

Auto-generated unique identifier of the payment method token generated by the Ezypay Vault.

primaryboolean

Specifies this token as the customer's preferred token for making payments. Supported values are true and false. If the customer has no primary payment method specified, then the new token will become the primary payment method by default. However, if the owner already has a primary payment method, then it will not change unless primary is set to true. PromptPay payment method token cannot be set as the primary payment method.

Response

200

paymentMethodTokenstring
customerIdstring
typestring
bankunknown
invalidReasonunknown
lastUsedOnunknown
validboolean
primaryboolean

Example response

{
  "paymentMethodToken": "187b485f-1f40-4c35-8c0d-81f87888ffcd",
  "customerId": "37a2e1dd-c1d9-4fda-a077-6908877aa84c",
  "type": "CARD",
  "card": {
    "first6": "498765",
    "last4": "8769",
    "accountHolderName": "JaneDoe",
    "type": "VISA",
    "expiryMonth": "12",
    "expiryYear": "25"
  },
  "valid": true,
  "primary": true
}

Changes