Skip to main content

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>

Body

required

    data

    object

    A key for grouping different types of API data.

    type string

    The type of transaction.

    Example: payments

    attributes

    object

    A key for grouping payment identification data.

    paymentType string

    The type of payment transaction.

    Possible values: [tokenv3Split]

    Example: tokenv3Split
    merchantId string

    The merchant account number.

    Example: {{merchantId}}
    miscData string

    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.

    amount string

    The transaction amount in cents.

    Example: 500
    currency string

    The three-character code.

    Example: USD
    invoice string

    The invoice number for the transaction.

    Example: PAYMENT-TOKEN-7

    token

    object

    A key for grouping payment token information.

    holder string

    The first and last name on the account.

    Example: John Doe
    tokenId string

    The Token ID retrieved from the embedded checkout.

    Example: {{token}}
    expiry string

    The expiration date of the payment method.

    Example: 0229
    useAVS boolean

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

    Example: true

    billingAddress

    object

    A key for grouping billing address data.

    line1 string

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

    Example: 21 Jump Street
    line2 string

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

    Example: Suite 007
    city string

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

    Example: Los Angeles
    state string

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

    Example: CA
    zip string

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

    Example: 83204
    country string

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

    Example: USA

    split

    object

    A key for grouping split information.

    merchantId string

    The merchant ID for the split transaction.

    Example: {{merchantId2}}
    amount string

    The amount to be split in cents.

    Example: 100

Responses​

Created

Schema

    links

    object

    self string

    URL for the current resource.

    data

    object

    type string

    The type of transaction.

    id string

    The payment transaction identification code.

    attributes

    object

    A key for grouping payment identification data.

    paymentType string

    The application key.

    transaction

    object

    A key for grouping payment identification data.

    code string

    The banking entity response code.

    message string

    The status of the transaction.

    amount string

    The transaction amount in dollars and cents.

    invoice string

    The invoice number for the transaction.

    currency string

    The currency used for the transaction.