Create Split Payments

POST 
/payments

Use this endpoint to create a split payment.

Request

Header Parameters

Authorization string
appToken created by /auth/token Format: Bearer xxxxxx...
Example: Bearer <appToken>

application/json

Body

required

data

object

A key for grouping different types of API data.

typestring

The type of transaction.

Example: payments

attributes

object

A key for grouping payment identification data.

paymentTypestring

The type of payment transaction.

Possible values: [tokenv3Split]

Example: tokenv3Split

merchantIdstring

The merchant account number.

Example: {{merchantId}}

miscDatastring

Optional additional information to store with the call (optional).

Example: {"email":"[email protected]","originIp":"127.0.0.1","customerIp":"127.0.0.1","rawData":"Lorem ipsum"}

transaction

object

A key for grouping payment transaction data. Required for all payment types except secondSplit.

amountstring

The transaction amount in cents.

Example: 500

currencystring

The three-character code.

Example: USD

invoicestring

The invoice number for the transaction.

Example: PAYMENT-TOKEN-7

token

object

A key for grouping payment token information.

holderstring

The first and last name on the account.

Example: John Doe

tokenIdstring

The Token ID retrieved from the embedded checkout.

Example: {{token}}

expirystring

The expiration date of the payment method.

Example: 0229

useAVSboolean

True/False for requiring a ZIP match (or greater) to capture the payment.

Example: true

billingAddress

object

A key for grouping billing address data.

line1string

The card holder’s street address (optional but recommended).

Example: 21 Jump Street

line2string

The card holder’s additional street address information (optional but recommended).

Example: Suite 007

citystring

The card holder’s home city (optional but recommended).

Example: Los Angeles

statestring

The card holder’s home state (optional but recommended).

Example: CA

zipstring

The card holder’s zip or postal code (optional, but recommended.)

Example: 83204

countrystring

The card holder’s home country (optional but recommended).

Example: USA

split

object

A key for grouping split information.

merchantIdstring

The merchant ID for the split transaction.

Example: {{merchantId2}}

amountstring

The amount to be split in cents.

Example: 100

Responses

201

Created

application/json

Schema

Schema

links

object

selfstring

URL for the current resource.

data

object

typestring

The type of transaction.

idstring

The payment transaction identification code.

attributes

object

A key for grouping payment identification data.

paymentTypestring

The application key.

transaction

object

A key for grouping payment identification data.

codestring

The banking entity response code.

messagestring

The status of the transaction.

amountstring

The transaction amount in dollars and cents.

invoicestring

The invoice number for the transaction.

currencystring

The currency used for the transaction.

Example (from schema)

{
  "links": {
    "self": "string"
  },
  "data": {
    "type": "string",
    "id": "string",
    "attributes": {
      "paymentType": "string",
      "transaction": {
        "code": "string",
        "message": "string",
        "amount": "string",
        "invoice": "string",
        "currency": "string"
      }
    }
  }
}

Result

{
  "links": {
    "self": "x"
  },
  "data": {
    "type": "payments",
    "id": "{paymentId}",
    "attributes": {
      "paymentType": "card",
      "transaction": {
        "code": "0",
        "message": "Success",
        "amount": "500",
        "invoice": "123456",
        "currency": "USD",
        "authCode": "A11111",
        "avsResult": "T",
        "gross": "500",
        "net": "450",
        "grossMinusNet": "50",
        "fee": "35",
        "rate": "2.95"
      }
    }
  }
}