Sign in
Recipients

Retrieve a Recipient

get/recipients/{id}

Path parameters

idstring uuid required

The ID of the Recipient

Query parameters

payerIdstring uuid

The ID of the Payer the Recipient is scoped to

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

A Recipient object

idstring uuid
externalIdstring

Consumer defined ID that will be attached to this resource

businessNamestring
categoryIdstring uuid
createdAtstring date-time
status'ACTIVE' | 'INACTIVE' | 'UNKNOWN'

The status of an object

Example response

{
  "id": "a8d4e641-e130-43d1-90a0-9717561539aa",
  "businessName": "Coffee Beans Supply Co.",
  "categoryId": "d7a2beba-0c2c-42de-9690-26f00ba08339",
  "businessAddress": {
    "line1": "19439 Stevens Creek Blvd",
    "city": "Cupertino",
    "state": "CA",
    "postalCode": "95014",
    "country": "US"
  },
  "contact": {
    "firstName": "Bob",
    "lastName": "Smith",
    "email": "bobsmith@coffeebean.supply",
    "phone": "4155550100"
  },
  "payer": {
    "id": "8f51c396-6e29-49a6-ba5a-1a31d5420158"
  },
  "metadata": {
    "accountSettings": {
      "emailConfirmation": true,
      "phoneConfirmation": true,
      "singleSignOn": true,
      "singleSignOnType": "OKTA",
      "twoFactor": true,
      "multiFactor": true
    },
    "beneficialOwners": [
      {
        "firstName": "Bob",
        "lastName": "Smith"
      }
    ]
  },
  "receivingMethod": {
    "accountNumber": "3829473294723",
    "routingNumber": "021000021",
    "beneficiaryName": "Coffee Beans Supply Co."
  },
  "createdAt": "2020-11-19T01:35:53.096Z",
  "status": "ACTIVE"
}

Changes

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