Create Payee

post

https://api.cpxenterprise.com/payee/v1/payee

This route will create a new payee

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Definition for a new payee

name

string

required

(\S)

Name of the payee

payeeType

string

enum

required

Allowed:

address

object

Address

contacts

array of objects

Contact information for the payee

contacts

paymentTypes

array of objects

required

Financial information for the payee

paymentTypes*

merchantId

string

(^$|\S)

A valid string

xmid

string

(^$|\S)

A valid string

phone

string

(^$|^\d{10}$)

A valid Phone Number

ssn

string

(^(?!0{8})[0-9][0-9]{8}$)

A valid SSN

dob

date

addedRelationshipBuyerIds

array of objects

required

Buyer relationship to this payee

addedRelationshipBuyerIds*

status

string

enum

required

externalStatus

string

enum

required

Allowed:

mcc

object

Merchant Category Code

acceptsCheck

boolean

acceptsCard

boolean

acceptsACH

boolean

requiresLodged

boolean

expirePreAuths

boolean

Responses

201

Success

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

500Error