Returns

In Vortex Global Payments, a Return transaction is used to refund a cardholder by referencing a previously completed sale or saleCompletion. You can issue either a full or a partial refund based on business needs.

Prerequisites & Limitations

merchant.processor.name must be "priority".
currencyCode must be "CAD" (Canadian Dollars).
totalAmount must be greater than 0.50.
originalExternalId must reference a completed sale or saleCompletion.

💡
You can issue multiple partial returns until the total refunded equals the original amount. If you attempt to exceed the original transaction’s amount, the return will fail.

In this guide, you’ll find:

How to issue a full return to refund the entire original sale amount
How to issue a partial return for less than the original amount
How to interpret the response payload from a return request

Return Transaction

Request Payload

{
  "ecom": false,
  "moto": false,
  "recurring": true,
  "externalId": "some-external-id",
  "originalExternalId": "some-original-external-id",
  "transactionType": "return",
  "totalAmount": 100.24,
  "currencyCode": "CAD",
  "merchant": {
    "name": "PPS Engineering UAT 2",
    "sic": "3501",
    "number": "518089240725465",
    "processor": {
      "name": "priority"
    },
    "globalAccountId": "acct_global-account-id"
  },
  "account": {
    "form": "plastic",
    "expiry": "2027-12",
    "number": "4242424242424242"
  },
  "device": {},
  "customer": {
    "address": {
      "street1": "2001 Westside",
      "city": "Alpharetta",
      "state": "GA",
      "postalCode": "30004"
    }
  }
}

Response Body

{
  "reference": "pi_3RQaQMKX2PidZXm21IiamEIc",
  "status": "succeeded",
  "approved": true,
  "declined": false,
  "message": "Approved",
  "requiredActions": "none",
  "totalAmount": 100.24,
  "requestedAmount": 100.24,
  "surchargeAmount": 0,
  "code": 0,
  "authCode": null,
  "authorization": {
    "avsChecks": {
      "addressLine1": true,
      "postalCode": true,
      "cvc": false
    },
    "network": {
      "adviceCode": null,
      "networkAdviceCode": null,
      "networkStatus": "approved_by_network"
    }
  },
  "cardType": "Discover",
  "network": "discover",
  "cardBin": {
    "type": "",
    "bank": {
      "www": "",
      "name": "",
      "phone": ""
    },
    "bin": "60111111",
    "brand": "DISCOVER",
    "country": {
      "iso": "840",
      "info": "",
      "name": "United States",
      "abbreviation2": "US",
      "abbreviation3": "USA"
    },
    "id": "60111111",
    "source": "pci.bindb.com",
    "level": "",
    "prepaid": null,
    "reloadable": null,
    "business": null,
    "regulated": false
  },
  "accountNumberMask": "1117",
  "id": "W5maDArOHuScyUE+yan1bg==",
  "meta": {
    "id": "W5maDArOHuScyUE+yan1bg==",
    "externalId": "1747687011835",
    "received": "2025-05-19T20:36:52.030Z",
    "tenantId": "A1A9550E-830C-474E-9836-DFD4DB492BC0",
    "tenantName": "Test Tenant",
    "replicationGroup": "qa",
    "virtualEnv": "qa-atl",
    "originatingInstance": "natl",
    "environment": "default"
  }
}

Implementation Notes

A return must reference a valid originalExternalId from a prior sale or saleCompletion transaction.
The return amount cannot exceed the original totalAmount.
If issuing multiple partial returns, each must reference the same original transaction.
Additional validations may apply depending on processor rules and merchant configuration.