PayFacto API - v1.0 - POST /v1/iapRefund

Refunds a previously settled IAP (Interac Automated Payment) Purchase or IAP Completion after batch close. Full and partial refunds are supported — the refund amount must not exceed the original transaction amount. The OriginalAuthorizationNumber, OriginalTransactionNumber, OriginalInvoiceNumber, and OriginalAmount from the original transaction response are all required.

Prerequisites

🔑

API Key

Generate your API key from the Payments Manager: Administrator Client → API Key → Add New Key. Pass it as auth-api-key in every request.

🏪

Company & Merchant Numbers

Your CompanyNumber (5-digit) and MerchantNumber (8-digit) are issued by PayFacto during onboarding. Both must match the company and merchant numbers of the original IAP transaction.

🌐

Environment Base URL

Test: https://test.api.payfacto.cloud/v1 | Production: Provided by the PayFacto Integration team upon certification.

📦

Request Format — Base64-Encoded Payload

Requests use HTTP POST with an application/x-www-form-urlencoded body. Assemble all parameters as a cleartext query string, Base64-encode it, then send: auth-api-key={key}&payload={base64}. For terminal transactions (InputType=N), send CardNumber as 40 space characters and ExpirationDate as 4 space characters.

🏦

IAP — Interac Automated Payment

IAP (Interac Automated Payment) endpoints handle Interac debit transactions processed through integrated systems. This endpoint refunds a settled IAP Purchase or IAP Completion. It cannot be used to refund credit card transactions — use /v1/refund for those.

📅

Post-Batch Refund — Full or Partial

This endpoint is used after batch close to return funds to the cardholder's Interac debit account. The refund Amount must be equal to or less than the OriginalAmount. To reverse a transaction on the same business day before batch close, use IAP Purchase Correction (/v1/iapPurchaseCorrection) instead.

↩️

Original IAP Transaction Required

The OriginalAuthorizationNumber, OriginalTransactionNumber, OriginalInvoiceNumber, and OriginalAmount must all be taken from the response of the original IAP Purchase (/v1/iapPurchase) or IAP Completion (/v1/iapCompletion).

Request

POST https://test.api.payfacto.cloud/v1/iapRefund

ℹ️

All parameters are passed inside the Base64-encoded payload form field. Raw body format: auth-api-key=<key>&payload=<base64>. For terminal transactions (InputType=N), send CardNumber as 40 space characters and ExpirationDate as 4 space characters.

Required fields

Field	Type	Description
CompanyNumber	Numeric(5)	Identifies the merchant on PayFacto's network. Must match the company number of the original IAP transaction. Example: `12345`
MerchantNumber	Numeric(8)	Identifies the merchant to PayFacto's network. Must match the merchant number of the original IAP transaction. Example: `53400000`
CustomerNumber	Alphanumeric(8)	Merchant-assigned customer identifier. Associates a client record with the transaction. Example: `CLIENT12`
Amount	Numeric(11)	The amount to refund to the cardholder's Interac debit account, including the decimal portion, left (0) padded. Must be equal to or less than `OriginalAmount`. Example: `00000010000` = $100.00
InvoiceNumber	Alphanumeric(12)	Merchant-generated invoice number for this IAP Refund. May be unique or reused per merchant needs. Example: `REF000000001`
InputType	Alphanumeric(1)	How the transaction is initiated. `N` = terminal/pinpad (Semi-Integrated), `I` = Internet/E-Commerce, `M` = MOTO, `U` = Unattended.
CardType	Alphanumeric(1)	Card brand. For `InputType=N` send a blank space. For `I`/`M`: `A` = Amex, `M` = Mastercard, `V` = Visa, `I` = Diners, `O` = Discover. Blank for unknown.
CardNumber	Alphanumeric(40)	Cardholder's card number, left-justified and space-padded to 40 characters. For `InputType=N`, send 40 space characters — the terminal reads the card directly.
ExpirationDate	Numeric(4)	Card expiration date in `MMYY` format. For `InputType=N`, send 4 space characters. Example: `1226`
MerchantTerminalNumber	Numeric(5)	Identifies the terminal on PayFacto's network. For E-Commerce transactions, send 5 blank spaces. Example: `12345`
LanguageCode	Alphanumeric(1)	Language for PayFacto responses and terminal display. `F` = French, `E` = English.
CurrencyCode	Alphanumeric(3)	Currency of the transaction (indicative only). `CAD` = Canadian dollars, `USD` = US dollars (requires a US merchant number).
OperatorID	Alphanumeric(8)	Identifies the cashier, agent, or system that initiated the transaction. Example: `USER0001`
OriginalInvoiceNumber	Alphanumeric(12)	The merchant's invoice number from the original IAP Purchase or IAP Completion. Must match the invoice number recorded on the original transaction exactly. Example: `PUR000000001`
OriginalAuthorizationNumber	Alphanumeric(8)	The authorization number returned in the response of the original IAP Purchase or IAP Completion. Example: `APPROV01`
OriginalTransactionNumber	Numeric(12)	The transaction number returned in the response of the original IAP Purchase or IAP Completion. Example: `000111222333`
OriginalAmount	Numeric(11)	The amount of the original IAP Purchase or IAP Completion, including the decimal portion, left (0) padded. The refund `Amount` must not exceed this value. Example: `00000010000` = $100.00

Optional fields

Field	Type	Description
taxAmount	Numeric(11)	Total tax amount included in `Amount`, left (0) padded. Example: `00000000374` = $3.74
TrxOption	Alpha(50)	Adds transaction-level options. Accepted values: `isCredentialOnFile`, `isRecurring`, `isInstallment` (mutually exclusive).
UserEchoData	Alphanumeric(256)	Custom data printed on the terminal receipt (Semi-Integrated only). Pipe-delimited line segments. Contact PayFacto integration before use.

Request — Code Example

⚠️

The example below uses the test endpoint and a sandbox API key, and shows a terminal (InputType=N) full IAP Refund. Replace credentials and base URL before going live. The refund must reference a settled IAP Purchase or IAP Completion.

cURL

# IAP Refund -- POST /v1/iapRefund
# Step 1: Build the cleartext payload (InputType=N, terminal reads card directly)
PAYLOAD="CompanyNumber=12345&MerchantNumber=53400000&CustomerNumber=CLIENT12&Amount=00000010000&InvoiceNumber=REF000000001&InputType=N&CardType= &CardNumber=                                        &ExpirationDate=    &MerchantTerminalNumber=12345&LanguageCode=E&CurrencyCode=CAD&OperatorID=USER0001&OriginalInvoiceNumber=PUR000000001&OriginalAuthorizationNumber=APPROV01&OriginalTransactionNumber=000111222333&OriginalAmount=00000010000"

# Step 2: Base64-encode the payload
ENCODED=$(echo -n "$PAYLOAD" | base64)

# Step 3: Submit the request
curl -X POST "https://test.api.payfacto.cloud/v1/iapRefund" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "auth-api-key=YOUR_TEST_API_KEY&payload=$ENCODED"

Response

Always returned

Field	Type	Description
returnCode	Alphanumeric(4)	Identifies the exact status of the transaction result. `00` = refund approved. All other values indicate a failure. Refer to Section 6 for endpoint-specific codes.
authorizationNumber	Alphanumeric(8)	Authorization code for the refund transaction. Mandatory to display on all customer receipts. Example: `REFND001`
transactionNumber	Numeric(12)	Unique PayFacto gateway transaction identifier for this IAP Refund. Example: `000111222444`
amount	Numeric(11)	Echo of the requested refund amount.
accountType	Alphanumeric(1)	Account type used for the transaction. `C` = Chequing, `S` = Savings.
bankTerminalNumber	Alphanumeric(8)	Terminal identifier at the banking acquirer that processed the transaction.
batchNumber	Numeric(4)	Batch number used when the refund was processed. Can be used when generating client receipts. Example: `0002`
cardNumber	Alphanumeric(40)	Echo of the request CardNumber (masked).
cardType	Alphanumeric(1)	Card brand determined by the network. `D` = Debit (Interac) is expected for IAP transactions.
companyNumber	Numeric(5)	Echo of the request CompanyNumber.
expirationDate	Numeric(4)	Echo of the request ExpirationDate, in `MMYY` format.
invoiceNumber	Alphanumeric(12)	Echo of the request InvoiceNumber.
languageCode	Alphanumeric(1)	Echo of the request LanguageCode.
merchantNumber	Numeric(8)	Echo of the request MerchantNumber.
operatorId	Alphanumeric(8)	Echo of the request OperatorID.
receiptDisp	Alphanumeric(32)	PayFacto-generated receipt message. Can be used to produce a receipt. Example: `APPROVED-THANK-YOU`
referenceNumber	Alphanumeric(10)	Reference number obtained following successful processing of the refund.
sequenceNumber	Alphanumeric(12)	Sequence number generated by the banking acquirer.
serverNumber	Alphanumeric(4)	Identifies the PayFacto Network server that processed the transaction.
terminalDisp	Alphanumeric(24)	Transaction message displayed on the terminal or payment page. Example: `APPROVED`
terminalNumber	Numeric(5)	Identifies the terminal in the PayFacto Network used to process the transaction.
timeStamp	Alphanumeric(17)	Date and time the transaction was processed on the payment server. Format: `YYYYMMDD-HHMMSSCC`. Example: `20240516-10000100`
trxCode	Alphanumeric(2)	Transaction type code. For an IAP Refund this is always `03`.
trxDate	Numeric(8)	Transaction date at the banking acquirer. Format: `MMDDYYYY`. May differ from timeStamp.
trxMethod	Alphanumeric(3)	Summarizes how the transaction was processed. First character: `D` = swiped, `T` = manual entry. Third character: `1` = authorized. Example: `D@1`
trxTime	Numeric(6)	Transaction time at the banking acquirer. Format: `HHMMSS`. May differ from timeStamp.
trxType	Alphanumeric(1)	Type of card used. For IAP transactions this will be `D` = Debit.

Conditionally returned

Field	Type	Description
customerNumber	Alphanumeric(8)	Only returned when provided in the request. Echo of the request CustomerNumber.
cvmResults	Alphanumeric(6)	Only returned for chip (EMV) transactions. Cardholder Verification Method result. Print a signature line on the receipt if the first 2 digits are `03`, `05`, `43`, `45`, `1E`, or `5E`.
demoMode	Alphanumeric(4)	Only returned when the terminal is in demo mode. Value will be `true`.
emvAID	Alphanumeric(32)	Only returned for chip (EMV) transactions. EMV Application Identifier. Example: `AID: A000000277`
emvLabel	Alphanumeric(16)	Only returned for chip (EMV) transactions. Human-readable application label. Example: `Interac`
emvTC	Alphanumeric(40)	Only returned for chip (EMV) transactions. EMV Transaction Cryptogram. Example: `TC: A2E51243D4C7E551`
emvTSI	Alphanumeric(4)	Only returned for chip (EMV) transactions. EMV Transaction Status Information.
emvTVR	Alphanumeric(10)	Only returned for chip (EMV) transactions. EMV Terminal Verification Result.
errorDescription	Alphanumeric(50)	Only returned when the transaction is not approved. Human-readable description of the failure reason.
surchargeAmount	Numeric(11)	Only returned when a surcharge was applied. Left (0) padded.
taxAmount	Numeric(11)	Only returned when `taxAmount` was included in the request. Echo of the submitted tax amount.
terminalInvoiceNumber	Numeric(12)	Only returned for terminal transactions. Terminal-assigned invoice number.
tipAmount	Numeric(11)	Only returned when a tip was added at the terminal. Left (0) padded.
token	Alphanumeric(35)	Only returned when tokenization is enabled. Token linked to the cardholder for future token-based transactions.

Response — Code Example

JSON — 200 Approved

{
  "returnCode":          "00",
  "authorizationNumber": "REFND001",
  "transactionNumber":   "000111222444",
  "referenceNumber":     "0000000002",
  "amount":              "00000010000",
  "accountType":         "C",
  "cardNumber":          "457300XXXXXX0001                       ",
  "cardType":            "D",
  "trxType":             "D",
  "trxCode":             "03",
  "trxDate":             "05162024",
  "trxTime":             "100001",
  "trxMethod":           "D@1",
  "timeStamp":           "20240516-10000100",
  "batchNumber":         "0002",
  "sequenceNumber":      "000011112223",
  "serverNumber":        "0001",
  "terminalNumber":      "12345",
  "bankTerminalNumber":  "00000001",
  "companyNumber":       "12345",
  "merchantNumber":      "53400000",
  "invoiceNumber":       "REF000000001",
  "expirationDate":      "    ",
  "languageCode":        "E",
  "operatorId":          "USER0001",
  "receiptDisp":         "APPROVED-THANK-YOU      ",
  "terminalDisp":        "APPROVED        "
}

JSON — Declined / Error

{
  "returnCode":        "9066",
  "errorDescription":  "INVALID ORIGINAL TRANSACTION STATUS",
  "terminalDisp":      "DECLINED        ",
  "receiptDisp":       "DECLINED                ",
  "transactionNumber": "000111222445",
  "timeStamp":         "20240516-10000200"
}

Error / Return Codes

The following codes are most relevant to this endpoint. For the complete catalogue see the Return Code Index.

Return Code	Meaning	When it occurs	Recommended Action
00	Transaction approved	The refund was approved and funds are being returned to the cardholder's Interac debit account.	Display the `authorizationNumber` on the customer receipt. No follow-up operation is required.
05	Transaction declined	The IAP Refund was declined by the issuing bank.	Retry the transaction. If the problem persists, contact PayFacto customer service.
9004	"Null" value: company number	`CompanyNumber` is null or blank in the payload.	Check your application. The field must correspond to the specification in the documentation.
9005 / 9006	Invalid / rejected: company number	`CompanyNumber` does not match the required 5-digit length or is not configured in the payment solution.	Make sure the application uses the correct company number provided by PayFacto. If it does, contact PayFacto customer service.
9007	"Null" value: merchant number	`MerchantNumber` is null or blank in the payload.	Check your application. The field must correspond to the specification in the documentation.
9008 / 9009	Invalid / rejected: merchant number	`MerchantNumber` does not match the required 8-digit length or is not configured in the payment solution.	Make sure the application uses the merchant number provided by PayFacto. If it does, contact PayFacto customer service.
9013 / 9014 / 9015	Null / invalid / rejected: amount	`Amount` is null, does not match the required 11-digit length, or does not follow the specification.	Confirm the amount is left (0) padded to 11 digits and does not exceed the original transaction amount. If the problem persists, contact PayFacto customer service.
9016 / 9017 / 9018	Null / invalid / rejected: invoice number	`InvoiceNumber` is null, exceeds 12 characters, or does not follow the specification.	Check your application. The field must correspond to the specification in the documentation.
9019 / 9020 / 9021	Null / invalid / rejected: input type	`InputType` is null, not a single character, not in the list of accepted values, or not associated with the merchant.	Check your application. The field must correspond to the specification in the documentation.
9022 / 9023 / 9024	Null / invalid / rejected: card type	`CardType` is null, not a single character, or not in the list of accepted values.	Check your application. For terminal transactions send a blank space.
9025 / 9026 / 9027	Null / invalid / rejected: card number	`CardNumber` is null, exceeds 40 characters, or does not follow the specification.	For terminal transactions send 40 space characters.
9028 / 9029 / 9030	Null / invalid / rejected: expiration date	`ExpirationDate` is null, not 4 characters, or does not follow the specification.	For terminal transactions send 4 space characters.
9031	"Null" value: POS terminal number	`MerchantTerminalNumber` is null or blank when a terminal transaction is being attempted.	Check your application. For terminal transactions provide a valid terminal number; for E-Commerce send 5 blank spaces.
9032 / 9033	Invalid / rejected: POS terminal number	`MerchantTerminalNumber` does not follow the specification, or the merchant is not configured as a POS terminal merchant.	Check your application. The field must correspond to the specification in the documentation. If the problem persists, contact PayFacto customer service.
9056 / 9057 / 9058	Null / invalid / rejected: original invoice number	`OriginalInvoiceNumber` is null, exceeds 12 characters, or was rejected because it does not follow the specification.	Make sure you are sending the invoice number exactly as it appeared on the original IAP Purchase or IAP Completion.
9062	Company number mismatch	The original transaction number exists but is not associated with your company number.	Make sure the original IAP transaction was processed under your company number.
9063	Merchant number mismatch	The original transaction number exists but is not associated with your merchant number.	Make sure the original IAP transaction was processed under your merchant number.
9064	Original invoice number mismatch	The `OriginalInvoiceNumber` sent does not match the invoice number recorded on the original IAP transaction.	The original invoice number must be identical to the one used in the original IAP Purchase or IAP Completion request.
9066	Invalid original transaction status	The original IAP transaction's status does not allow a refund — it may have been declined, cancelled, or already fully refunded. If the batch has not yet closed, a correction may have been applied instead.	Verify the original IAP transaction was approved and settled. Check your records to confirm it has not already been fully refunded. If the batch has not yet closed, use IAP Purchase Correction (`/v1/iapPurchaseCorrection`) instead.
9067	Original authorization number mismatch	The `OriginalAuthorizationNumber` is not associated with the submitted original transaction number.	Make sure the `OriginalAuthorizationNumber` matches the value returned in the original IAP Purchase or IAP Completion response.
9068	Original transaction number not found	No transaction matching the submitted `OriginalTransactionNumber` exists in the system.	Check your application. Make sure you are sending the correct transaction number from the original IAP Purchase or IAP Completion response.
9069	Original transaction is not a refundable IAP type	The original transaction referenced is not an IAP Purchase or IAP Completion. Only settled IAP Purchase and IAP Completion transactions can be refunded via this endpoint.	Check your application. Make sure the original transaction number corresponds to an IAP Purchase or IAP Completion. For IAP Pre-Authorization transactions that have not been completed, use Void (`/v1/void`) instead.
3666	One or more terminals are busy	All of the merchant's terminals are currently processing transactions.	Wait and retry. If the problem persists, contact PayFacto customer service.
3667	Semi-integrated terminal is busy	The target terminal is currently processing another transaction or a recovery is in progress.	Wait 15 seconds and retry. If the problem persists, contact PayFacto customer service.
3668	Waiting for a recovery	An error occurred with the semi-integrated terminal. A recovery must be completed before another operation can be processed.	Make sure everything is plugged in correctly. If needed, restart the driver and unplug then replug the terminal power. Wait 35 seconds and retry. If the problem persists, contact PayFacto customer service.
3777	Inexistent terminal and/or merchant	The merchant or terminal has not been configured in the Dispatcher module.	If the problem persists, contact PayFacto customer service.
9051	Time out	Transaction processing timed out. Often caused by an inactive Dispatcher module.	Retry the transaction. If the problem persists, contact PayFacto customer service.
9049 / 9050	Fatal error	A critical error occurred while processing the transaction.	Retry the transaction. If the problem persists, contact PayFacto customer service.