List Payment Methods

• URL

  /host/pgw/api/payment-methods/list

• Method:

  GET

• Header params

  An authentication token is required to prevent unauthorized access to protected data.

  Required:

  -> auth_token=[string] - authorization token

• URL Params

  Api will consume only query params.

  Required:

  • id=[string] - user id

• Success Response:
  Response is successful:

  • If valid authentication token is provided

  Response contains an array of payment methods registered for id(user_id)

  Code: 200
  
  Content:

  {
  
      "payment_methods": [
  
        {
  
            "id": "k_4aHegxkz9hUexamplefqpY-o_DapuSL",
  
            "name": "John Smith",
  
            "user_id": "[email protected]",
  
            "card_type": "visa",
  
            "masked_pan": "***-1111",
  
            "year": "2019",
  
            "month": "10",
  
            "expires_soon": false
  
        }
  
      ]
  
  }

• Error Response:

  Error response can occur in scenario described bellow

  • Wrong or missing auth token

    • Code: 401 UNAUTHORIZED