Create Payor

Onboard a payor and assign them to a customer. All details are optional barring the ID and First/Last name

SecurityOAuth2: OAuth2Flow

Request

path Parameters

required

string

Customer ID

header Parameters

Authorization	string OAuth bearer token (see authentication flows)
x-l2f-request-id	string Optional Unique ID per request, useful for fault resolution/diagnosis and audit.
x-l2f-idempotency-id	string Unique ID used to safely retry an operation. See idempotency section for more details.

Request Body schema: application/json

id required	string Unique ID to be associated to this payor. Payor IDs must be unique per customer. The Payor ID follow the External Identifier pattern
first_name	string First Name (Mandatory if individual)
middle_name	string Middle Name
last_name	string Last Name (Mandatory if individual)
email_address	string Email Address
phone_number	string Telephone Number
company_name	string Company Name (Mandatory if corporation)
state required	string State / Province (2 Digit subdivision component of the ISO 3166-2 code, which consists of the last two characters. https://en.wikipedia.org/wiki/ISO_3166-2
country_code required	string Country of Payor (2 Digit ISO31661-Alpha2 Format - https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/customers/{id}/payor

Request samples

Payload

application/json

{"id": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"company_name": "string",
"state": "string",
"country_code": "string"
}

Response samples

application/json

{"data": {"id": "string"
}
}