Skip to main content

refundsRequest

merchantRefNumstringrequired

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

Possible values: <= 255 characters

Example: P1234
amountnumber

This is the amount of the request, in minor units. For example, to process US $10.99, this value should be 1099.

Possible values: <= 99999999999

dupCheckboolean

This validates that this request is not a duplicate. A request is considered a duplicate if the merchantRefNum has already been used in a previous request within the past 90 days.

Note: This value defaults to true.

Default value: true
splitpay object[]
  • Array [
  • linkedAccountstringrequired

    This is the ID of the linked account. This account must already be linked to the merchant account.

    Example: 123124124
    amountnumber

    This is the amount to transfer to the linked account in minor currency units. The total amount to all linked accounts cannot exceed the transaction total.

    Example: 505
    percentnumber

    This is the percentage of the total transaction amount to transfer to that account. The total percentage to all linked accounts cannot exceed 100%.

    Example: 5
  • ]
  • refundsRequest
    {
    "merchantRefNum": "P1234",
    "amount": 0,
    "dupCheck": true,
    "splitpay": [
    {
    "linkedAccount": "123124124",
    "amount": 505,
    "percent": 5
    }
    ]
    }