Get Payor

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v2/payors/{payorId}

Get a Single Payor by Id.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v2/payors/'

Response Example

200 - Example 1

{
    "address": {
        "city": "Key West",
        "country": "US",
        "countyOrProvince": "FL",
        "line1": "500 Duval St",
        "line2": "line2",
        "line3": "line3",
        "line4": "line4",
        "zipOrPostcode": "33945"
    },
    "allowsLanguageChoice": true,
    "collectiveAlias": "Payee",
    "dbaName": "Some Biz",
    "includesReports": true,
    "kycState": "PASSED_KYC",
    "language": "EN",
    "manualLockout": true,
    "maxMasterPayorAdmins": 6,
    "payeeGracePeriodDays": 0,
    "payeeGracePeriodProcessingEnabled": true,
    "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "payorName": "Example, Corp",
    "payorXid": "ABC_201234",
    "primaryContactEmail": "joe.buck@example.com",
    "primaryContactName": "Joe Buck",
    "primaryContactPhone": "123-123-1234",
    "reminderEmailsOptOut": true,
    "remoteSystemIds": [
        "REMOTE_SYSTEM_ID",
        "REMOTE_SYSTEM_ID"
    ],
    "supportContact": "support@example.com",
    "transmissionTypes": {
        "ACH": true,
        "SAME_DAY_ACH": true,
        "WIRE": true
    },
    "wuCustomerId": "wuCustomerId"
}

Request

Path Params

Responses

🟢200Get Payor Details

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404Payor Id Not Found

Modified at 2022-09-11 21:50:18

Reminder Email Opt-Out

Create a Payor Link