Skip to content
On this page

/payment/list/{clientId}

Retrieve a list of payment methods on file for a client.

HTTP Request

GET https://api.q2open.io/v1/payment/list/{clientId}

Arguments

ParameterDescription
clientIdID of client to retrieve payment methods for.

Returns

A dictionary with a data property that contains an array of payment method objects.

Example Request

shell
curl "https://api.q2open.io/v1/payment/list/566595c8ce88ccec69328566" \
  -H "Authorization: Bearer dc220490-e6ee-11e5-8a94-e7385a8d929e" \
  -G

Example Response

json
{
  "data": [
    {
      "_id": "580e3754dec21e861b5a3718",
      "type": "card",
      "identifier": "optional_custom_identifier",
      "status": "verified",
      "default": true,
      "name": "Demo User",
      "card": {
        "number": "XXXX4242",
        "brand": "visa",
        "type": "credit",
        "expDate": "2016-12-01T12:00:00.000Z"
      }
    },
    {
      "_id": "580e3e11dec21e861b5a3719",
      "type": "bank",
      "identifier": "optional_custom_identifier",
      "status": "declined",
      "name": "Demo User",
      "bank": {
        "routing": "XXXX2531",
        "account": "XXXX4124",
        "type": "checking"
      }
    }
  ]
}