REFUND

REFUND processes a refund for a transaction that has been previously captured. The capture may be either full or partial.

Successful requests will be indicated with a 2xx HTTP response code and the Approved attribute set to 'true'.

NOTE

It is possible to receive a 2xx HTTP response code and have the Approved attribute set to 'false'.

Available Functions

Perform a 'refund' transaction

POST, /v0/transaction/refund

REQUEST Object Attributes

refundTable
Attribute	Data Type	Description	Required
Amount	object	Amount Object	True
Total	decimal	Total Transaction Amount Total is aKey/Value of the "Amount" Object.	True
Currency	string	ISO 3-letter currency code Currency is aKey/Value of the "Amount" Object.	True
TransactionID	ksuid	Transaction ID from the Capture Response	False
Payment Method	object	Transaction Payment Method	True
Card	object	Card info Card is aKey/Value of the "Payment Method" Object.	True
CardPresent	boolean	Indicates if this card is present CardPresent is aKey/Value of the "Card" Object.	True
CVC	object	Card Verification Value (AKA CVV2) CVC is aKey/Value of the "Card" Object.	False
CVC	string	Card Verification Value (AKA CVV2) CVC is aKey/Value of the "CVC" Object.	False
PAN	object	Personal Account Number Info PAN is aKey/Value of the "Card" Object.	True
PAN	string	Personal Account Number PAN is aKey/Value of the "PAN" Object.	True
ExpMonth	string	Account Expiration Month (MM) ExpMonth is aKey/Value of the "PAN" Object.	True
ExpYear	string	Account Expiration Year (YY) ExpYear is aKey/Value of the "PAN" Object.	True
Track2	object	Track 2 Data Track2 is aKey/Value of the "Card" Object.	False
Track2	string	Track 2 string ("Start" and "End" sentinels required) Track2 is aKey/Value of the "Track2" Object.	False
PIN	object	PIN PIN is aKey/Value of the "Card" Object.	False
Data	string	PIN Data Data is aKey/Value of the "PIN" Object.	False
KSN	string	Key Serial Number KSN is aKey/Value of the "PIN" Object.	False
BillingAddress	object	Customer billing address BillingAddress is aKey/Value of the "Card" Object.	False
Name	string	Customer name (Full Name) Name is aKey/Value of the "BillingAddress" Object.	False
Line1	string	Customer address line 1 Line1 is aKey/Value of the "BillingAddress" Object.	False
Line2	string	Customer address line 2 Line2 is aKey/Value of the "BillingAddress" Object.	False
City	string	Customer city City is aKey/Value of the "BillingAddress" Object.	False
State	string	Customer state State is aKey/Value of the "BillingAddress" Object.	False
PostalCode	string	Customer postal code (AKA Zip Code) PostalCode is aKey/Value of the "BillingAddress" Object.	False
Country	string	Customer country Country is aKey/Value of the "BillingAddress" Object.	False
Phone	string	Customer Phone Number Phone is aKey/Value of the "BillingAddress" Object.	False
Email	string	Customer Email Email is aKey/Value of the "BillingAddress" Object.	False
ICC	object	See Attributes in Integrated Circuit Card Data Section ICC is aKey/Value of the "Card" Object.	False
3DSecure	object	3D Secure Result data for verification of card transactions 3DSecure is aKey/Value of the "Card" Object.	False
Authentication Value	string	Authentication value from 3D Secure results Authentication Value is aKey/Value of the "3DSecure" Object.	False
ECommerceIndicator	string	ECommerce indicator (ECI) from 3D Secure results ECommerceIndicator is aKey/Value of the "3DSecure" Object.	False
3DSecureTransactionID	string	3D Secure Transaction ID from 3D Secure results 3DSecureTransactionID is aKey/Value of the "3DSecure" Object.	False
Token	object	Indicates the Token ID as the payment method Token is aKey/Value of the "Payment Method" Object.	False
TokenID	ksuid	Token ID TokenID is aKey/Value of the "Token" Object.	False
DataAction	string	Data Action	False
Attributes	object	Transaction attributes	False
EntryMode	object	Description of the card entry mode EntryMode is aKey/Value of the "Attributes" Object.	False
ProcessingSpecifiers	object	Description of the specific data used for processing the transaction. ProcessingSpecifiers is aKey/Value of the "Attributes" Object.	False
Recurring	object	See Recurring Section (Use with Recurring Payment, Standing Payment, Unscheduled Payment requests)	False
Detail	object	Transaction Details	False
MerchantData	object	Merchant Defined Transaction Data (supports 1 or more Merchant Defined Keys) MerchantData is aKey/Value of the "Detail" Object.	False
MerchantDefinedKey1	string	Merchant - defined transaction data (field 1) MerchantDefinedKey1 is aKey/Value of the "MerchantData" Object.	False
MerchantDefinedKey2	string	Merchant - defined transaction data (field 2) MerchantDefinedKey2 is aKey/Value of the "MerchantData" Object.	False
Order	object	Order data details for purchase (Standard Data and Corporate Data) Order is aKey/Value of the "Detail" Object.	False
Item	object array	Item data details for purchase (Standard Data and Corporate Data) Item is aKey/Value of the "Detail" Object.	False
ShipTo	object	ShipTo receiver data (Standard Data and Corporate Data) ShipTo is aKey/Value of the "Detail" Object.	False
ShipFrom	object	ShipFrom sender data (Standard Data and Corporate Data) ShipFrom is aKey/Value of the "Detail" Object.	False
Shipment	object array	Shipment details in Detail Shipment Data Section (Standard Data and Corporate Data) Shipment is aKey/Value of the "Detail" Object.	False
TransactionEntry	object	See Transaction Entry Section (Information about transaction entry)	False

REQUEST Example: eCommerce

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/refund
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Currency": "USD"
    },
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Detail": {
        "MerchantData": {
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: Retail (magnetic stripe with PIN)

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/refund
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";5204****2784=2512901?"
            },
            "PIN": {
                "Data": "6AAEAEB42F24D677",
                "KSN": "FFFF9876543210E00002"
            }
        }
    },
    "Attributes": {
        "EntryMode": "magstripe",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true,
            "DebitDirect": true
        }
    },
    "TransactionEntry": {
        "Device": "Ingenico Move/5000",
        "DeviceVersion": "0.0",
        "Application": "EXAMPLE POS App",
        "ApplicationVersion": "0.0",
        "Timestamp": "2021-02-02T14:06:18"
    },
    "Detail": {
        "MerchantData": {
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: Retail (magnetic stripe without PIN)

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/refund
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";5204****2784=2512901?"
            }
        }
    },
    "Attributes": {
        "EntryMode": "magstripe",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Ingenico Move/5000",
        "DeviceVersion": "0.0",
        "Application": "EXAMPLE POS App",
        "ApplicationVersion": "0.0",
        "Timestamp": "2021-02-02T14:06:18"
    },
    "Detail": {
        "MerchantData": {
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: Restaurant (EMV)

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/refund
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";4005520000000129=221220118358262?"
            },
            "ICC": {
                "CardSequenceNumber": "000",
                "TerminalCapabilities": "000000",
                "TerminalVerificationResults": "8000010000",
                "UnpredictableNumber": "9BADBCAB",
                "IssuerApplicationData": "0F400102030405060708090A0B0C0D0E",
                "ApplicationCryptogram": "30148FDAF37B80AD",
                "ApplicationTransactionCounter": "00FF",
                "ApplicationInterchangeProfile": "0000",
                "TransactionType": "00",
                "TerminalCountryCode": "0826",
                "TransactionDate": "010101",
                "AmountAuthorized": "000000012300",
                "TransactionCurrencyCode": "0826",
                "AmountOther": "000000000000",
                "FormFactorIndicator": "00000001"
            }
        }
    },
    "Attributes": {
        "EntryMode": "contactless-chip",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Ingenico Move/5000",
        "DeviceVersion": "0.0",
        "Application": "EXAMPLE POS App",
        "ApplicationVersion": "0.0",
        "Timestamp": "2021-02-02T14:06:18"
    }
}'

RESPONSE Object Attributes

defaultResponseTable
Attribute	Data Type	Description
TransactionID	ksuid	Unique transaction lifetime system ID
EventID	ksuid	Unique transaction event system ID
RequestID	ksuid	Unique transaction request system ID
Approved	boolean	Request approval indicator
Token	object	Request approval indicator
TokenID	ksuid	Token ID TokenID is aKey/Value of the "Token" Object.
TokenName	string	Unique Name of the Token Used TokenName is aKey/Value of the "Token" Object.

RESPONSE Example

JSON Response Object

json

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "Approved": true
}

REFUND ​

Available Functions ​

Perform a 'refund' transaction ​

REQUEST Object Attributes ​

REQUEST Example: eCommerce ​

REQUEST Example: Retail (magnetic stripe with PIN) ​

REQUEST Example: Retail (magnetic stripe without PIN) ​

REQUEST Example: Restaurant (EMV) ​

RESPONSE Object Attributes ​

RESPONSE Example ​

REFUND

Available Functions

Perform a 'refund' transaction

REQUEST Object Attributes

REQUEST Example: eCommerce

REQUEST Example: Retail (magnetic stripe with PIN)

REQUEST Example: Retail (magnetic stripe without PIN)

REQUEST Example: Restaurant (EMV)

RESPONSE Object Attributes

RESPONSE Example