SPspinwheel
Payers

Get a List of Payers

You can retrieve a list of the Payers you've created by sending a GET request to: /v1/payments/payers

A successful response returns an array that contains identifying information for each of the Payers, including the PayerId, the name of the institution, and the last four digits of the account number.

get/v1/payments/payers

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/payments/payers
  • Auth
    API key in header Authorization

Response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": [
    {
      "payerId": "c555734f-6473-4d13-9943-2264cb1ee2dd",
      "userId": "c555734f-6473-4d13-9943-2264cb1ee2dd",
      "payerType": "PARTNER",
      "payerSubType": "PARTNER",
      "label": "Personal Loans",
      "accountLast4Digits": "1010",
      "institutionName": "Axis Bank Pvt. Ltd.",
      "tokenType": "PLAID",
      "verificationStatus": {
        "status": "IN_PROGRESS",
        "statusUpdateTs": 1614602485926
      },
      "createdOn": 1614602485926,
      "updatedOn": 1614602485926
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.