v1

latestOpenAPI 3.0.12026-07-24256962.9 KB

Payers

Retrieve a Payer

get/payers/{id}

Path parameters

idstring uuid required

The ID of the Payer

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

End-User-OSstring

The Operating System of the end user. Recommended for compliance.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturerstring

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Modelstring

The device model used by the end user. Recommended for compliance.

Response

Payer retrieved successfully.

idstring uuid

externalIdstring

Consumer defined ID that will be attached to this resource

businessNamestring

createdAtstring date-time

status'ACTIVE' | 'INACTIVE' | 'UNKNOWN'

The status of an object

hasIdentityDocumentsboolean

Indicates whether the payer has saved identity documents

Example response

{
  "id": "8f51c396-6e29-49a6-ba5a-1a31d5420158",
  "businessName": "Philz Coffee",
  "contact": {
    "firstName": "Bob",
    "lastName": "Smith",
    "email": "bobsmith@coffeebean.supply",
    "phone": "4155550100"
  },
  "businessAddress": {
    "line1": "360 9th St.",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US"
  },
  "status": "ACTIVE",
  "hasIdentityDocuments": true,
  "identityDocuments": [
    {
      "type": "US_SSN"
    }
  ],
  "metadata": {
    "accountSettings": {
      "emailConfirmation": true,
      "phoneConfirmation": true,
      "singleSignOn": true,
      "singleSignOnType": "OKTA",
      "twoFactor": true,
      "multiFactor": true
    }
  }
}