v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

PayIDs

Retrieve a PayID

Retrieve the details of a specific PayID using the unique id parameter id. Only one PayID record is returned.

get/pay_ids/{id}

Path parameters

idstring uuid required

Id of the PayID resource.

Response

idstring uuid

pay_idstring email

type'EMAIL'

status'active' | 'activation_failed' | 'pending_activation' | 'deregistered'

created_atstring date-time

updated_atstring date-time

Example response

{
  "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
  "pay_id": "jsmith@mydomain.com",
  "type": "EMAIL",
  "status": "active",
  "created_at": "2020-04-27T20:28:22.378Z",
  "updated_at": "2020-04-27T20:28:22.378Z",
  "details": {
    "pay_id_name": "J Smith",
    "owner_legal_name": "Mr John Smith"
  },
  "links": {
    "self": "/pay_ids/46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
    "virtual_accounts": "/virtual_accounts/46deb476-c1a6-41eb-8eb7-26a695bbe5bc"
  }
}