createPayor

MUTATION

Creates payor.

Arguments

inputRequired

PayorInput

The input object that contains the payor information to create a new payor. Detailed information about the input object can be found here.

Response

Payor

address_line1

String| null

The first line of the address of the payor.

address_line2

String| null

The second line of the address of the payor.

city

String| null

The city of the payor.

country

String| null

The country of the payor.

email

String| null

The email address of the payor.

full_name

String| null

The full name of the payor.

merchant_uid

String| null

The Pay Theory unique identifier assigned to the merchant that the payor belongs to.

metadata

AWSJSON| null

The metadata to attach to the payor. This is a JSON object that can contain any data that you want to attach to the payor.

payor_id

String| null

The unique payor id.

phone

String| null

The phone number of the payor.

postal_code

String| null

The postal code of the payor.

region

String| null

The region of the payor.

Examples

Create a payor

Creates a payor with contact information and metadata.

SUCCESS 200

GRAPHQL

mutation CreatePayor($input: PayorInput!) {
  createPayor(input: $input) {
    payor_id
    merchant_uid
    full_name
    email
    phone
    address_line1
    city
    region
    postal_code
    country
    metadata
  }
}