Skip to main content

Refund Split Payments

POST 

/payments

Use this endpoint to split a refund of 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.

    typestring

    The type of transaction.

    Example: payments

    attributes

    object

    A key for grouping payment identification data.

    paymentTypestring

    The type of payment transaction.

    Possible values: [cardSplitRefund]

    Example: cardSplitRefund
    merchantIdstring

    The merchant account number.

    Example: {{merchantId}}
    miscDatastring

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

    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: 123456

    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

    originalSplit

    object

    A key for referencing the original payment to be refunded.

    idstring

    The transaction ID to be refunded.

    Example: {{splitpaymentId}}

Responses

Created

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.