Process a direct payment authorization and capture.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "20.00",
"tax": "0.01",
"customfee": "1",
"msg": "APPROVED",
"desc": "APPROVAL TAS992",
"additional_info": null,
"clerk_id": null,
"clerk_name": null,
"clerk_label": null,
"additionalKeyOne": null,
"additionalKeyTwo": null,
"additionalValueOne": null,
"additionalValueTwo": null,
"approval_code": "TAS992",
"rrn": "608305501153",
"txnid": "10169526",
"created_date": "24/03/2026",
"created_time": "01:36:44",
"tran_no": 1,
"stan": 687540,
"batch_no": 582,
"is_partial_approve": 0,
"partial_amount": "000000002000",
"pan": "XXXX1111",
"card_type": null,
"phone_number": "1111111111",
"email_id": "[email protected] ",
"zip": null,
"card_holder_name": "JOHN SMITH",
"expiry_date": "12/36",
"address": "0.01",
"epi": "2412333540",
"channel": "ECOMM",
"orderdescription": "king size bed 10x12",
"invoicenumber": "inv0001",
"token": "11FD46************2A9A9E",
"card_brand": "Visa",
"netamt": 21
}
Field Type Description error_nostring S00 indicates a successful transactionsuccess_urlboolean true when the transaction is approvederror_codestring Gateway error code. 00 = no error amountstring Charged amount in decimal format (e.g. "20.00") taxstring Tax amount, if applicable customfeestring Custom fee applied to the transaction msgstring Result (e.g. APPROVED) descstring Detailed description additional_infostring | null Reserved for additional metadata clerk_idstring | null Clerk identifier, if provided clerk_namestring | null Clerk name, if provided clerk_labelstring | null Clerk label, if provided additionalKeyOnestring | null Custom key field 1 additionalKeyTwostring | null Custom key field 2 additionalValueOnestring | null Custom value field 1 additionalValueTwostring | null Custom value field 2 approval_codestring Issuer-returned authorization code rrnstring Retrieval reference number for reconciliation txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full approvalpartial_amountstring Approved amount in zero-padded 12-digit format panstring Masked card number — last 4 digits shown (e.g. XXXX1111) card_typestring | null Card type, if returned by the issuer phone_numberstring Cardholder phone number, if provided email_idstring Cardholder email address, if provided zipstring | null Billing ZIP code, if provided card_holder_namestring Name on card, if provided expiry_datestring Card expiry in MM/YY format addressstring Billing address, if provided epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) orderdescriptionstring Item or order description invoicenumberstring Merchant-supplied invoice reference tokenstring Card token for future use or recurring charges card_brandstring Card network (e.g. Visa, Mastercard) netamtnumber Net amount charged including fees
JSON
{
"error_no": "E98",
"error_code": "14",
"success_url": false,
"txnid": "10169529",
"batch_no": 582,
"switch_error_code": "V0564",
"mesg": "Invalid card number",
"desc": "Error code :14",
"msg": "Invalid card number",
"isFlexSendOrNot": "V0564"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Issuer decline code (e.g. 14 = invalid card number) success_urlboolean Always false for declined transactions txnidstring Transaction identifier (assigned even on decline) batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code returned by the network mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
JSON
{
"error_no": "D27",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID EPI ID"
}
Field Type Description error_nostring D27 indicates a processing or configuration errormesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Transaction successful E98Declined E98 indicates a declined transactionD27Processing error Invalid EPI ID or configuration issue
Process a payment using a previously stored card token.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "10.00",
"tax": "0.01",
"customfee": "1.02",
"msg": "APPROVED",
"desc": "APPROVAL TAS215",
"additional_info": null,
"clerk_id": null,
"clerk_name": null,
"clerk_label": null,
"additionalKeyOne": null,
"additionalKeyTwo": null,
"additionalValueOne": null,
"additionalValueTwo": null,
"approval_code": "TAS215",
"rrn": "608305501593",
"txnid": "10169532",
"created_date": "24/03/2026",
"created_time": "01:43:54",
"tran_no": 2,
"stan": 687542,
"batch_no": 582,
"is_partial_approve": 0,
"partial_amount": "000000001000",
"pan": "XXXX1111",
"card_type": null,
"phone_number": "1111111111",
"email_id": "[email protected] ",
"zip": null,
"card_holder_name": "JOHN SMITH",
"expiry_date": "/",
"address": "26 Test",
"epi": "2412333540",
"channel": "ECOMM",
"orderdescription": "king size bed 10x12",
"invoicenumber": "inv0001",
"token": "11FD46************2A9A9E",
"card_brand": "Visa",
"netamt": 11.02
}
Field Type Description error_nostring S00 indicates a successful transactionsuccess_urlboolean true when the transaction is approvederror_codestring Gateway error code. 00 = no error amountstring Charged amount in decimal format taxstring Tax amount, if applicable customfeestring Custom fee applied to the transaction msgstring Result (e.g. APPROVED) descstring Detailed description additional_infostring | null Reserved for additional metadata clerk_idstring | null Clerk identifier, if provided clerk_namestring | null Clerk name, if provided clerk_labelstring | null Clerk label, if provided additionalKeyOnestring | null Custom key field 1 additionalKeyTwostring | null Custom key field 2 additionalValueOnestring | null Custom value field 1 additionalValueTwostring | null Custom value field 2 approval_codestring Issuer-returned authorization code rrnstring Retrieval reference number for reconciliation txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full approvalpartial_amountstring Approved amount in zero-padded 12-digit format panstring Masked card number — last 4 digits shown card_typestring | null Card type, if returned by the issuer phone_numberstring Cardholder phone number, if provided email_idstring Cardholder email address, if provided zipstring | null Billing ZIP code, if provided card_holder_namestring Name on card, if provided expiry_datestring Card expiry in MM/YY format. Returns "/" when not stored with the token addressstring Billing address, if provided epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) orderdescriptionstring Item or order description invoicenumberstring Merchant-supplied invoice reference tokenstring Card token used for this transaction card_brandstring Card network (e.g. Visa, Mastercard) netamtnumber Net amount charged including fees
JSON
{
"error_no": "E98",
"error_code": "V1",
"success_url": false,
"txnid": "10169535",
"batch_no": 582,
"switch_error_code": "V0605",
"mesg": "Invalid card token",
"desc": "Error code :V1",
"msg": "Invalid card token",
"isFlexSendOrNot": "V0605"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Issuer decline code (e.g. V1 = invalid card token) success_urlboolean Always false for declined transactions txnidstring Transaction identifier (assigned even on decline) batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code returned by the network mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
JSON
{
"error_no": "E05",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID AMOUNT"
}
Field Type Description error_nostring E05 indicates an input validation or processing errormesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Transaction successful E98Declined E98 indicates a declined transactionE05Processing error Invalid or missing amount in the request
Process a Level 2 / Level 3 direct payment with enhanced transaction data for corporate and purchasing cards.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "10.00",
"tax": "0.01",
"customfee": "1.02",
"msg": "APPROVED",
"desc": "APPROVAL TAS495",
"additional_info": null,
"clerk_id": null,
"clerk_name": null,
"clerk_label": null,
"additionalKeyOne": null,
"additionalKeyTwo": null,
"additionalValueOne": null,
"additionalValueTwo": null,
"approval_code": "TAS495",
"rrn": "608305501954",
"txnid": "10169562",
"created_date": "24/03/2026",
"created_time": "01:52:04",
"tran_no": 4,
"stan": 687551,
"batch_no": 582,
"is_partial_approve": 0,
"partial_amount": "000000001000",
"pan": "XXXX1111",
"card_type": null,
"phone_number": "1111111111",
"email_id": "[email protected] ",
"zip": null,
"card_holder_name": "JOHN SMITH",
"expiry_date": "12/36",
"address": "26 Test",
"epi": "2412333540",
"channel": "ECOMM",
"orderdescription": "king size bed 10x12",
"invoicenumber": "inv0001",
"token": "11FD46************2A9A9E",
"card_brand": "Visa",
"netamt": 11.02
}
Field Type Description error_nostring S00 indicates a successful transactionsuccess_urlboolean true when the transaction is approvederror_codestring Gateway error code. 00 = no error amountstring Charged amount in decimal format taxstring Tax amount, if applicable customfeestring Custom fee applied to the transaction msgstring Result (e.g. APPROVED) descstring Detailed description approval_codestring Issuer-returned authorization code rrnstring Retrieval reference number for reconciliation txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full approvalpartial_amountstring Approved amount in zero-padded 12-digit format panstring Masked card number — last 4 digits shown expiry_datestring Card expiry in MM/YY format epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) tokenstring Card token for future use or recurring charges card_brandstring Card network (e.g. Visa, Mastercard) netamtnumber Net amount charged including fees
JSON
{
"error_no": "E98",
"error_code": "54",
"success_url": false,
"txnid": "10169568",
"batch_no": 582,
"switch_error_code": "V0548",
"mesg": "Card expired",
"desc": "Error code :54",
"msg": "Card expired",
"isFlexSendOrNot": "V0548"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Issuer decline code (e.g. 54 = card expired) success_urlboolean Always false for declined transactions txnidstring Transaction identifier (assigned even on decline) batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code returned by the network mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
JSON
{
"error_no": "E07",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID EXPIRY DATE"
}
Field Type Description error_nostring E07 indicates an expiry date validation errormesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Transaction successful E98Declined E98 indicates a declined transactionE07Processing error Invalid or malformed expiry date in the request
Process a Level 2 / Level 3 payment using a previously stored card token.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "10.00",
"tax": "0.01",
"customfee": "1.02",
"msg": "APPROVED",
"desc": "APPROVAL TAS614",
"additional_info": null,
"clerk_id": null,
"clerk_name": null,
"clerk_label": null,
"additionalKeyOne": null,
"additionalKeyTwo": null,
"additionalValueOne": null,
"additionalValueTwo": null,
"approval_code": "TAS614",
"rrn": "608305501959",
"txnid": "10169571",
"created_date": "24/03/2026",
"created_time": "01:52:48",
"tran_no": 5,
"stan": 687553,
"batch_no": 582,
"is_partial_approve": 0,
"partial_amount": "000000001000",
"pan": "XXXX1111",
"card_type": null,
"phone_number": "1111111111",
"email_id": "[email protected] ",
"zip": null,
"card_holder_name": "JOHN SMITH",
"expiry_date": "/",
"address": "26 Test",
"epi": "2412333540",
"channel": "ECOMM",
"orderdescription": "king size bed 10x12",
"invoicenumber": "inv0001",
"token": "11FD46************2A9A9E",
"card_brand": "Visa",
"netamt": 11.02
}
Field Type Description error_nostring S00 indicates a successful transactionsuccess_urlboolean true when the transaction is approvederror_codestring Gateway error code. 00 = no error amountstring Charged amount in decimal format taxstring Tax amount, if applicable customfeestring Custom fee applied to the transaction msgstring Result (e.g. APPROVED) descstring Detailed description approval_codestring Issuer-returned authorization code rrnstring Retrieval reference number for reconciliation txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full approvalpartial_amountstring Approved amount in zero-padded 12-digit format panstring Masked card number — last 4 digits shown expiry_datestring Card expiry in MM/YY format. Returns "/" when not stored with the token epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) tokenstring Card token used for this transaction card_brandstring Card network (e.g. Visa, Mastercard) netamtnumber Net amount charged including fees
JSON
{
"error_no": "E98",
"error_code": "V1",
"success_url": false,
"txnid": "10169574",
"batch_no": 582,
"switch_error_code": "V0605",
"mesg": "Invalid card token",
"desc": "Error code :V1",
"msg": "Invalid card token",
"isFlexSendOrNot": "V0605"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Issuer decline code (e.g. V1 = invalid card token) success_urlboolean Always false for declined transactions txnidstring Transaction identifier batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
JSON
{
"error_no": "D03",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "TXN TYPE IS REQUIRED"
}
Field Type Description error_nostring D03 indicates a missing required field errormesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Transaction successful E98Declined E98 indicates a declined transactionD03Processing error Required field txn_type missing from the request
Generate a secure hosted payment page URL to collect card details from the customer.
JSON
{
"error_no": "S00",
"url": "https://securelink-staging.valorpaytech.com:443//?uid=Z8ULm***********vz0FZ9&redirect=1",
"uid": "Z8ULm***********vz0FZ9"
}
Field Type Description error_nostring S00 indicates the hosted page was created successfullyurlstring Secure hosted payment page URL. Redirect the customer to this link to complete payment uidstring Unique identifier for this payment link. Use this for update, resend, or cancel operations
JSON
{
"error_no": "D06",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "NOT A VALID APP ID"
}
Field Type Description error_nostring D06 indicates an invalid APP IDmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Hosted page URL created D06Processing error Invalid or unrecognised App ID in the request
Update an existing hosted payment link and resend it to the customer. Only links in pending status can be updated or resent.
JSON
{
"error_no": "S00",
"url": "https://securelink-staging.valorpaytech.com:443//?uid=Z8ULm***********vz0FZ9&redirect=1",
"uid": "Z8ULm***********vz0FZ9"
}
Field Type Description error_nostring S00 indicates the link was updated and resent successfullyurlstring Updated hosted payment page URL uidstring UID for the payment link
JSON
{
"error_no": "A36",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "ONLY PENDING EINVOICE CAN BE RESEND"
}
Field Type Description error_nostring A36 indicates the invoice is not in a resendable statemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Link updated and resent A36Processing error Invoice is not in pending status and cannot be resent
Generate a secure hosted payment page URL with Level 2 / Level 3 data support.
JSON
{
"error_no": "S00",
"url": "https://securelink-staging.valorpaytech.com:443//?uid=Z8ULm***********vz0FZ9&redirect=1",
"uid": "Z8ULm***********vz0FZ9"
}
Field Type Description error_nostring S00 indicates the hosted page was created successfullyurlstring Secure hosted payment page URL. Redirect the customer to this link to complete payment uidstring Unique identifier for this payment link
JSON
{
"error_no": "D07",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "NOT A VALID APP KEY"
}
Field Type Description error_nostring D07 indicates an invalid APP keymesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Hosted page URL created D07Processing error Invalid or unrecognised App Key in the request
Update an existing L2/L3 hosted payment link and resend it.
JSON
{
"error_no": "S00",
"url": "https://securelink-staging.valorpaytech.com:443//?uid=Z8ULm***********vz0FZ9&redirect=1",
"uid": "Z8ULm***********vz0FZ9"
}
Field Type Description error_nostring S00 indicates the link was updated and resent successfullyurlstring Updated hosted payment page URL uidstring UID for the payment link
JSON
{
"error_no": "A18",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID UID"
}
Field Type Description error_nostring A18 indicates the provided UID is invalid or not foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Link updated and resent A18Processing error UID does not exist or is not associated with an active
Cancel an existing hosted payment link.
JSON
{
"error_no": "S00",
"desc": "SUCCESS",
"msg": "EINVOICE CANCELED"
}
Field Type Description error_nostring S00 indicates the invoice was cancelled successfullymsgstring Confirmation message (e.g. EINVOICE CANCELED) descstring Detailed description
JSON
{
"error_no": "A39",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "TRANSACTION IS ALREADY IN EXPIRED STATUS"
}
Field Type Description error_nostring A39 indicates the transaction cannot be cancelled in its current statemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Invoice cancelled A39Processing error Transaction is already expired and cannot be cancelled
When a customer completes or fails a payment on the hosted page, the following result screens are rendered.
Displayed to the customer after a successful payment.
Element Value Title APPROVEDBody message Your transaction has been successfully processed.Icon Green checkmark Style Bootstrap modal, green accent (#82ce34)
Displayed when the payment link has expired or the payment could not be completed.
Element Value Error display 404-style layout with spinning question-circle iconMessage Payment Link expiredBackground colour #95c2de (light blue)
Note: The expired page uses a 404-style layout to indicate the payment is no longer valid. Customers should contact the merchant for a new payment link.
Increase the authorized amount on an existing pre-authorization.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "50.00",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"desc": "APPROVAL TAS343",
"additional_info": null,
"clerk_id": null,
"clerk_name": null,
"clerk_label": null,
"additionalKeyOne": null,
"additionalKeyTwo": null,
"additionalValueOne": null,
"additionalValueTwo": null,
"approval_code": "TAS343",
"rrn": "608306502107",
"txnid": "10169607",
"created_date": "24/03/2026",
"created_time": "02:06:59",
"tran_no": 11,
"stan": 687563,
"batch_no": 582,
"is_partial_approve": 0,
"partial_amount": "000000005000",
"pan": "XXXX",
"card_type": null,
"phone_number": "1111111111",
"email_id": "[email protected] ",
"zip": null,
"card_holder_name": "JOHN SMITH",
"expiry_date": "/",
"address": "26 Test",
"epi": "2412333540",
"channel": "ECOMM",
"orderdescription": "Test",
"invoicenumber": "Test",
"token": "11FD46************2A9A9E",
"card_brand": null,
"netamt": 50
}
Field Type Description error_nostring S00 indicates a successful incremental authorizationsuccess_urlboolean true when the authorization is approvederror_codestring Gateway error code. 00 = no error amountstring Incremental authorization amount in decimal format approval_codestring Issuer-returned authorization code rrnstring Retrieval reference number for reconciliation txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full approvalpartial_amountstring Authorized amount in zero-padded 12-digit format panstring Masked card number epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) netamtnumber Net authorized amount
JSON
{
"error_no": "E14",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID TRANSACTION ID"
}
Field Type Description error_nostring E14 indicates the referenced transaction ID is invalidmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Incremental authorization successful E14Processing error Transaction ID not found or does not support incremental auth
Issue a refund against a previously settled transaction.
JSON
{
"error_no": "S00",
"error_code": "00",
"amount": "5.00",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"txnid": "10169628",
"desc": "APPROVAL TAS435",
"additional_info": null,
"epi": "2412333540",
"channel": "ECOMM",
"created_date": "24/03/2026",
"created_time": "02:13:07",
"rrn": "608306502151"
}
Field Type Description error_nostring S00 indicates a successful refunderror_codestring Gateway error code. 00 = no error amountstring Refunded amount in decimal format taxstring Tax amount, if applicable customfeestring Custom fee, if applicable msgstring Result (e.g. APPROVED) txnidstring Unique transaction identifier for the refund descstring Detailed description additional_infostring | null Reserved for additional metadata epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) created_datestring Refund date in DD/MM/YYYY format created_timestring Refund time in HH:MM:SS format rrnstring Retrieval reference number for reconciliation
JSON
{
"error_no": "E03",
"mesg": "TRANSACTION NOT ALLOWED",
"desc": "Input field is missing"
}
Field Type Description error_nostring E03 indicates a missing required input fieldmesgstring High-level error category descstring Detailed description
JSON
{
"error_no": "E98",
"error_code": "12",
"success_url": false,
"txnid": "10169619",
"batch_no": 582,
"switch_error_code": "V0543",
"mesg": "Original transaction not found",
"desc": "Error code :12",
"msg": "Original transaction not found",
"isFlexSendOrNot": "V0543"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Issuer decline code (e.g. 12 = original transaction not found) success_urlboolean Always false for declined transactions txnidstring Transaction identifier assigned to the failed refund attempt batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
error_noMeaning Typical cause S00Approved Refund processed successfully E03Missing input A required field was not provided in the request E98Declined E98 indicates a declined transaction
Retrieve a paginated list of transactions for a given terminal.
JSON
{
"number_of_records": 1,
"data": [
{
"CARD_TYPE": "DEBIT",
"EPI": "2412333540",
"LABEL": "VT #2",
"DATE": "03-24-2026",
"REF_TXN_ID": "10169628",
"TIME": "02:13 AM",
"TIMEZONE": "EST",
"AUTH_CODE": "TAS435",
"APPROVAL_CODE": "TAS435",
"TOKEN": "11FD46************2A9A9E",
"RRN": "608306502151",
"TXN_TYPE": "REFUND",
"CARD_SCHEME": "Visa",
"PAN": "4111 XXXX XXXX 1111",
"RESPONSE_CODE": "00",
"CARDHOLDER_NAME": "JOHN SMITH",
"DBA_NAME": "Valor Store LLC",
"INVOICE_NO": "inv0001",
"POS_ENTRY_MODE": "012",
"BASE_AMOUNT": "500",
"CUSTOM_FEE_AMOUNT": "0",
"NET_AMOUNT": "500",
"TIP_AMOUNT": "0",
"TAX_DETAILS": {
"stateTax": { "rate": 0, "amount": 0, "taxableSales": 500 },
"cityTax": { "rate": 0, "amount": 0, "taxableSales": 500 },
"reducedTax": { "rate": 0, "amount": 0, "taxableSales": 0 }
},
"TOTAL_TAX": 0,
"TOTAL_WITH_TAX": 500,
"MID": "887000003193",
"CASHBACK_AMOUNT": "0",
"DEVICE_MODEL": "139",
"BATCH_NO": "582",
"STAN_NO": "687572",
"TRAN_NO": "12",
"POS_CONDITION_CODE": "59",
"IS_SETTLED": "0",
"REFUND_AMOUNT": "0",
"REFUND_COUNT": "0",
"IS_AUTH_COMPLETED": "0",
"IS_REVERSAL": "0",
"IS_VOID": "0",
"CARD_METADATA": {
"CARD_BIN": "411111",
"CARD_TYPE": "DEBIT",
"ISSUING_BANK": "CONOTOXIA SP. Z O.O",
"COUNTRY": "POLAND",
"CARD_LEVEL": "PERSONAL",
"CARD_CATEGORY": "CLASSIC"
},
"TXN_ORIG_DATE": "2026-03-24 06:13:06"
}
],
"status": "SUCCESS",
"meta": {
"number_of_records": 1,
"total_pages": 39,
"total_results": 39,
"page_number": 1,
"page_size": 1
}
}
Field Type Description number_of_recordsinteger Number of records returned in this page dataarray Array of transaction objects statusstring SUCCESS on successmetaobject Pagination metadata
Field Type Description CARD_TYPEstring Card type (e.g. DEBIT, CREDIT) EPIstring Merchant terminal / EPI identifier LABELstring Terminal label DATEstring Transaction date in MM-DD-YYYY format REF_TXN_IDstring Reference transaction ID TIMEstring Transaction time (e.g. 02:13 AM) TIMEZONEstring Timezone of the terminal (e.g. EST) AUTH_CODEstring Authorization code APPROVAL_CODEstring Issuer approval code TOKENstring Card token, if stored RRNstring Retrieval reference number TXN_TYPEstring Transaction type (e.g. SALE, REFUND, VOID) CARD_SCHEMEstring Card network (e.g. Visa, Mastercard) PANstring Masked card number (e.g. 4111 XXXX XXXX 1111) RESPONSE_CODEstring Gateway response code. 00 = approved CARDHOLDER_NAMEstring Name on card, if provided DBA_NAMEstring Merchant doing-business-as name INVOICE_NOstring Merchant-supplied invoice reference POS_ENTRY_MODEstring POS entry mode code BASE_AMOUNTstring Base transaction amount in cents CUSTOM_FEE_AMOUNTstring Custom fee amount in cents NET_AMOUNTstring Net charged amount in cents TIP_AMOUNTstring Tip amount in cents TAX_DETAILSobject Breakdown of state, city, and reduced tax TOTAL_TAXnumber Total tax amount in cents TOTAL_WITH_TAXnumber Total amount including tax in cents MIDstring Merchant ID CASHBACK_AMOUNTstring Cashback amount in cents DEVICE_MODELstring Device model identifier BATCH_NOstring Settlement batch number STAN_NOstring System trace audit number TRAN_NOstring Sequential transaction number IS_SETTLEDstring 1 if settled; 0 if pending settlementREFUND_AMOUNTstring Total refunded amount in cents REFUND_COUNTstring Number of refunds issued against this transaction IS_AUTH_COMPLETEDstring 1 if auth has been captured; 0 otherwiseIS_REVERSALstring 1 if this is a reversal transactionIS_VOIDstring 1 if this transaction has been voidedCARD_METADATAobject Card BIN metadata TXN_ORIG_DATEstring Original transaction timestamp in YYYY-MM-DD HH:MM:SS UTC
Field Type Description CARD_BINstring First 6 digits of the card number (BIN) CARD_TYPEstring Card type (e.g. DEBIT, CREDIT) ISSUING_BANKstring Name of the issuing bank COUNTRYstring Country of the issuing bank CARD_LEVELstring Card level (e.g. PERSONAL, CORPORATE) CARD_CATEGORYstring Card category (e.g. CLASSIC, PLATINUM)
Field Type Description number_of_recordsinteger Records returned on this page total_pagesinteger Total number of pages available total_resultsinteger Total number of matching records page_numberinteger Current page number page_sizeinteger Number of records per page
JSON
{
"error_no": "D35",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "FILTER KEY MUST BE SET TO TXNID WHEN DATE_FILTER IS 9"
}
Field Type Description error_nostring D35 indicates an invalid filter configurationmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00 (via status: SUCCESS)Success Records returned D35Processing error filter_key must be TXNID when date_filter is 9
Retrieve a paginated list of transactions filtered by a specific date range.
JSON
{
"number_of_records": 1,
"data": [
{
"CARD_TYPE": "DEBIT",
"EPI": "2412333540",
"DATE": "06-30-2024",
"REF_TXN_ID": "6545831",
"TXN_TYPE": "SALE",
"CARD_SCHEME": "Visa",
"PAN": "4111 XXXX XXXX 1111",
"CARDHOLDER_NAME": "Michael Jordan",
"DBA_NAME": "Valor Store LLC",
"BASE_AMOUNT": "500",
"CUSTOM_FEE_AMOUNT": "1020",
"NET_AMOUNT": "1520",
"IS_SETTLED": "1",
"BILLING_STREET_NO": "2 Jericho Plz",
"BILLING_ZIPCODE": "50001",
"TXN_ORIG_DATE": "2024-06-30 18:56:29"
}
],
"status": "SUCCESS",
"meta": {
"number_of_records": 1,
"total_pages": 116,
"total_results": 116,
"page_number": 1,
"page_size": 1
}
}
Note: The response schema is identical to the Transaction List API. Key differences: IS_SETTLED is "1" (settled), CARDHOLDER_NAME and BILLING_STREET_NO are populated, and CUSTOM_FEE_AMOUNT / NET_AMOUNT reflect a non-zero custom fee.
JSON
{
"error_no": "D29",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "START DATE AND END DATE REQUIRED"
}
Field Type Description error_nostring D29 indicates missing date range parametersmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00 (via status: SUCCESS)Success Records returned for the specified date range D29Processing error start_date or end_date missing from the request
Void an unsettled transaction, preventing it from being captured and settled.
JSON
{
"error_no": "S00",
"error_code": "00",
"amount": "20.00",
"tax": "0",
"customfee": "0",
"msg": "APPROVED",
"txnid": "10169634",
"desc": "APPROVAL TAS428",
"additional_info": null,
"epi": "2412333540",
"channel": "ECOMM",
"created_date": "24/03/2026",
"created_time": "02:15:22",
"rrn": "608306502148"
}
Field Type Description error_nostring S00 indicates the void was successfulerror_codestring Gateway error code. 00 = no error amountstring Amount of the voided transaction taxstring Tax amount on the voided transaction customfeestring Custom fee on the voided transaction msgstring Result (e.g. APPROVED) txnidstring Transaction identifier of the void descstring Detailed description additional_infostring | null Reserved for additional metadata epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) created_datestring Void date in DD/MM/YYYY format created_timestring Void time in HH:MM:SS format rrnstring Retrieval reference number
JSON
{
"error_no": "E98",
"error_code": "V5",
"success_url": false,
"txnid": "10169637",
"batch_no": 582,
"switch_error_code": "V0620",
"mesg": "VOID Transaction has already been performed",
"desc": "Error code :V5",
"msg": "VOID Transaction has already been performed",
"isFlexSendOrNot": "V0620"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Decline code (e.g. V5 = already voided) success_urlboolean Always false for declined operations txnidstring Transaction identifier batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
error_noMeaning Typical cause S00Approved Transaction voided successfully E98Declined E98 indicates a declined transaction
Settle all open transactions in the current batch for a given terminal.
JSON
{
"error_no": "S00",
"error_code": "00",
"amount": "141.08",
"tax": "0.00",
"customfee": "6.08",
"msg": "APPROVED",
"txnid": null,
"desc": null,
"additional_info": null,
"epi": "2412333540",
"channel": "ECOMM",
"created_date": "24/03/2026",
"created_time": "02:15:45",
"rrn": null
}
JSON
{
"error_no": "S00",
"error_code": "00",
"amount": "0.00",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"txnid": null,
"desc": null,
"additional_info": "Empty Batch",
"epi": "2412333540",
"channel": "ECOMM",
"created_date": "24/03/2026",
"created_time": "02:15:54",
"rrn": null
}
Field Type Description error_nostring S00 indicates the settlement request was acceptederror_codestring Gateway error code. 00 = no error amountstring Total settled amount. "0.00" for an empty batch taxstring Total tax amount settled customfeestring Total custom fees settled msgstring Result (e.g. APPROVED) txnidstring | null Not applicable for settlement; always null descstring | null Detailed description additional_infostring | null "Empty Batch" when no transactions were present; otherwise nullepistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) created_datestring Settlement date in DD/MM/YYYY format created_timestring Settlement time in HH:MM:SS format rrnstring | null Not applicable for settlement; always null
Note: Both a successful settlement and an empty batch return error_no: "S00". Check additional_info for the value "Empty Batch" to distinguish the two cases.
Capture a previously authorized transaction and move it to the open batch for settlement.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "1000.00",
"tax": "0.01",
"customfee": "0",
"msg": "APPROVED",
"desc": "APPROVAL TAS507",
"approval_code": "TAS507",
"rrn": "608306502177",
"txnid": "10169649",
"created_date": "24/03/2026",
"created_time": "02:16:26",
"tran_no": 2,
"stan": 687581,
"batch_no": 583,
"is_partial_approve": 0,
"partial_amount": "000000100000",
"pan": "XXXX",
"expiry_date": "/",
"epi": "2412333540",
"channel": "ECOMM",
"netamt": 1000
}
Field Type Description error_nostring S00 indicates a successful capturesuccess_urlboolean true when the capture is approvederror_codestring Gateway error code. 00 = no error amountstring Captured amount in decimal format msgstring Result (e.g. APPROVED) descstring Detailed description approval_codestring Issuer-returned authorization code rrnstring Retrieval reference number txnidstring Unique transaction identifier for the capture created_datestring Capture date in DD/MM/YYYY format created_timestring Capture time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full capturepartial_amountstring Captured amount in zero-padded 12-digit format epistring Merchant terminal / EPI identifier netamtnumber Net captured amount
JSON
{
"error_no": "E16",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID TRAN NO"
}
Field Type Description error_nostring E16 indicates the transaction number is invalidmesgstring Error message msgstring Error message descstring Detailed description
JSON
{
"error_no": "E98",
"error_code": "V5",
"success_url": false,
"txnid": "10169652",
"batch_no": 583,
"switch_error_code": "V0622",
"mesg": "Capture/Ticket Transaction has already been performed",
"desc": "Error code :V5",
"msg": "Capture/Ticket Transaction has already been performed",
"isFlexSendOrNot": "V0622"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Decline code (e.g. V5 = already captured) success_urlboolean Always false for declined operations txnidstring Transaction identifier batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
error_noMeaning Typical cause S00Approved Capture successful E16Processing error Invalid transaction number (tran_no) E98Declined E98 indicates a declined transaction
Retrieve the details of the currently open (unsettled) batch for a given terminal.
JSON
{
"status": "SUCCESS",
"statusMsg": "Open batch request success",
"batchSummary": [
{
"dashboard_netamount": 100000,
"dashboard_batchcount": 1
}
],
"batchSummaryDetails": [
{
"txn_id": 10169649,
"epi_id": "2412333540",
"txn_type": "COMPLETION",
"txn_type_code": 104,
"amount": 100000,
"tip_amount": 0,
"cashback_amount": 0,
"custom_fee_amount": 0,
"tax_amount": 0,
"tran_no": 2,
"stan_no": "687581",
"invoice_no": "3",
"batch_no": "583",
"pos_entry_mode": "812",
"masked_card_no": "4111 XXXX XXXX 1111",
"card_scheme": "Visa",
"request_date": "03-24-2026",
"request_time": "02:16 AM",
"store_time_zone": "EST",
"mid": "887000003193",
"tid": "75021674",
"rrn": "608306502177",
"approval_code": "TAS507",
"response_code": "00",
"is_voided": 0,
"is_auth_completed": 0,
"settled_at": "2026-03-24T06:16:25.000Z",
"created_at": "2026-03-24T06:16:25.000Z",
"txamount": 100000,
"surcharge_label": "Adjustment"
}
],
"epiInfo": {
"tip_adjust": true,
"max_tip": "350"
},
"meta": {
"number_of_records": 1,
"total_pages": 1,
"total_results": 1,
"page_number": 1,
"page_size": 1
},
"openBatchDetails": [
{
"base_amount_totals": 100000,
"total_transactions": 1,
"tip_counts": 0,
"total_tip_amount": 0,
"custom_fee_totals": 0,
"transaction_total_amount": 100000
}
]
}
Field Type Description statusstring SUCCESS on successstatusMsgstring Status message batchSummaryarray High-level batch totals batchSummaryDetailsarray Line-item transaction details epiInfoobject Terminal tip adjustment settings metaobject Pagination metadata openBatchDetailsarray Aggregated batch totals
Field Type Description dashboard_netamountnumber Total net amount in the open batch (cents) dashboard_batchcountnumber Total number of transactions in the open batch
Field Type Description txn_idinteger Unique transaction identifier epi_idstring Terminal / EPI identifier txn_typestring Transaction type (e.g. COMPLETION, SALE) amountnumber Transaction amount in cents tip_amountnumber Tip amount in cents custom_fee_amountnumber Custom fee amount in cents tran_nointeger Sequential transaction number stan_nostring System trace audit number batch_nostring Batch number masked_card_nostring Masked card number card_schemestring Card network rrnstring Retrieval reference number approval_codestring Issuer approval code is_voidedinteger 1 if voided; 0 otherwisesettled_atstring Settlement timestamp (ISO 8601) txamountnumber Total transaction amount in cents
Field Type Description tip_adjustboolean true if tip adjustment is enabled for this terminalmax_tipstring Maximum tip adjustment allowed (in cents)
Field Type Description base_amount_totalsnumber Sum of all base transaction amounts (cents) total_transactionsnumber Total number of transactions in the open batch tip_countsnumber Number of transactions with a tip total_tip_amountnumber Sum of all tip amounts (cents) custom_fee_totalsnumber Sum of all custom fees (cents) transaction_total_amountnumber Total batch amount including all fees (cents)
JSON
{
"error_no": "D27",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID EPI ID"
}
Field Type Description error_nostring D27 indicates an invalid EPI IDmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00 (via status: SUCCESS)Success Open batch details returned D27Processing error EPI ID not found or invalid
Retrieve transaction details for a previously settled (closed) batch.
JSON
{
"status": "SUCCESS",
"statusMsg": "Closed batch transaction details",
"transactionCount": 1,
"closedBatchDetails": [
{
"txn_id": 10169649,
"epi_id": "2412333540",
"txn_type": "COMPLETION",
"txn_type_code": 104,
"amount": 100000,
"tip_amount": 0,
"tran_no": 2,
"stan_no": "687581",
"batch_no": "583",
"masked_card_no": "4111 XXXX XXXX 1111",
"card_scheme": "Visa",
"mid": "887000003193",
"rrn": "608306502177",
"approval_code": "TAS507",
"response_code": "00",
"is_voided": 0,
"settled_at": "2026-03-24T06:16:25.000Z",
"txamount": 100000
}
],
"meta": {
"number_of_records": 1,
"total_pages": 1,
"total_results": 1,
"page_number": 1,
"page_size": 1
},
"closednewBatchDetails": [
{
"base_amount_totals": 100000,
"total_transactions": 1,
"tip_counts": 0,
"total_tip_amount": 0,
"custom_fee_totals": 0,
"transaction_total_amount": 100000
}
]
}
Field Type Description statusstring SUCCESS on successstatusMsgstring Status message transactionCountinteger Total number of transactions in the closed batch closedBatchDetailsarray Line-item transaction details metaobject Pagination metadata closednewBatchDetailsarray Aggregated batch totals
Field Type Description txn_idinteger Unique transaction identifier epi_idstring Terminal / EPI identifier txn_typestring Transaction type (e.g. COMPLETION, SALE) amountnumber Transaction amount in cents tran_nointeger Sequential transaction number stan_nostring System trace audit number batch_nostring Batch number masked_card_nostring Masked card number card_schemestring Card network rrnstring Retrieval reference number approval_codestring Issuer approval code response_codestring Gateway response code is_voidedinteger 1 if voided; 0 otherwisesettled_atstring Settlement timestamp (ISO 8601) txamountnumber Total transaction amount in cents
Field Type Description base_amount_totalsnumber Sum of all base transaction amounts (cents) total_transactionsnumber Total number of transactions in the batch tip_countsnumber Number of transactions with a tip total_tip_amountnumber Sum of all tip amounts (cents) custom_fee_totalsnumber Sum of all custom fees (cents) transaction_total_amountnumber Total batch amount including all fees (cents)
JSON
{
"code": 400,
"status": "FAILED",
"errors": ["batchNO is missing. Please provide an batchNO."],
"closednewBatchDetails": [
{
"base_amount_totals": 0,
"total_transactions": 0,
"tip_counts": 0,
"total_tip_amount": 0,
"custom_fee_totals": 0,
"transaction_total_amount": 0
}
]
}
Field Type Description codeinteger HTTP status code (400) statusstring FAILED when the request cannot be processederrorsarray List of validation error messages closednewBatchDetailsarray Returns zeroed totals when the request fails
statusMeaning Typical cause SUCCESSSuccess Closed batch details returned FAILEDValidation error batchNO missing from the request
Adjust the tip amount on a previously authorized transaction before settlement.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "5.00",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"desc": null,
"additional_info": null,
"approval_code": "TAS551",
"rrn": "608306502207",
"txnid": null,
"created_date": "24/03/2026",
"created_time": "02:18:44",
"tran_no": 4,
"stan": 687593,
"batch_no": 583,
"is_partial_approve": 0,
"partial_amount": "000000000500",
"pan": "XXXX",
"epi": "2412333540",
"channel": "VT",
"netamt": 5
}
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "50.00",
"msg": "APPROVED",
"additional_info": "Tip amount is same as previous tip adjusted amount",
"approval_code": "TAS551",
"rrn": "608306502207",
"txnid": null,
"created_date": "24/03/2026",
"created_time": "02:19:39",
"tran_no": 4,
"stan": 687593,
"batch_no": 583,
"partial_amount": "000000005000",
"pan": "XXXX",
"epi": "2412333540",
"channel": "VT",
"netamt": 50
}
Field Type Description error_nostring S00 indicates the tip adjustment was acceptedsuccess_urlboolean true when the adjustment is approvederror_codestring Gateway error code. 00 = no error amountstring Tip amount adjusted in decimal format msgstring Result (e.g. APPROVED) additional_infostring | null "Tip amount is same as previous tip adjusted amount" when no change was made; otherwise nullapproval_codestring Original authorization code from the parent transaction rrnstring Retrieval reference number of the parent transaction txnidstring | null Not returned for tip adjustments; always null created_datestring Adjustment date in DD/MM/YYYY format created_timestring Adjustment time in HH:MM:SS format tran_nointeger Transaction number of the original transaction staninteger System trace audit number batch_nointeger Settlement batch identifier partial_amountstring Tip amount in zero-padded 12-digit format epistring Merchant terminal / EPI identifier channelstring Channel used (e.g. VT = virtual terminal) netamtnumber Net tip amount
Note: Check additional_info for "Tip amount is same as previous tip adjusted amount" to identify no-op adjustments.
JSON
{
"error_no": "E34",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID STAN NO"
}
Field Type Description error_nostring E34 indicates the STAN number is invalidmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Tip adjusted or already at the same amount E34Processing error Invalid or unrecognised STAN number
Retrieve a hosted e-receipt URL for a completed transaction.
JSON
{
"error_no": "S00",
"status": "OK",
"mesg": "SUCCESS",
"eReceipt": "https://rcpt-staging.valorpaytech.com:4430/?id=10169658-608306502207--v3.0&type=cc"
}
Field Type Description error_nostring S00 indicates the e-receipt was retrieved successfullystatusstring OK on successmesgstring SUCCESS on successeReceiptstring URL to the hosted e-receipt page
JSON
{
"error_no": "G36",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "RECEIPT TYPE ALLOWED VALUES ARE 0, 1"
}
Field Type Description error_nostring G36 indicates an invalid receipt type valuemesgstring Error message msgstring Error message descstring Detailed description
JSON
{
"error_no": "91",
"status": "OK",
"msg": "PROCESSING ERROR",
"desc": "INVALID TXN ID"
}
Field Type Description error_nostring 91 indicates the transaction ID is invalid or not foundstatusstring OK is returned even on error for this response typemsgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success E-receipt URL returned G36Processing error Invalid receipt_type — must be 0 or 1 91Processing error Transaction ID not found or invalid
Retrieve a paginated list of e-invoices for a given terminal.
JSON
{
"status": "OK",
"message": "Success",
"number_of_records": 1,
"page_number": 1,
"total_results": 35,
"page_size": 1,
"total_pages": 35,
"data": [
{
"ID": 255817,
"UID": "Z8ULm***********vz0FZ9",
"EPI": "2412333540",
"INVOICE_MODE": "EINVOICE",
"AMOUNT_TYPE": "FIXED",
"AMOUNT": "20",
"TAX": "0.01",
"TIP": "0.01",
"SURCHARGE": "0.01",
"SURCHARGE_TYPE": null,
"SURCHARGE_INDICATOR": 1,
"SURCHARGE_PERCENTAGE": "1",
"ATTEMPTS": 0,
"CREATED_ON": "2026-03-24 06:00:48",
"NEVER_EXPIRE": 0,
"ACTIVE_ON": "2026-03-25 06:00:48",
"STATUS": "PAID",
"CUSTOMER_NAME": "Test",
"INVOICE_NO": "inv0001",
"PRODUCT_DESCRIPTION": "king size bed 10x12",
"SMS_STATUS": 0,
"TXN_ID": 10169598,
"RRN": "608306502066",
"PAYMENT_RECEIVED_ON": "2026-03-24 06:01:02",
"IS_QRCODE": 0,
"IS_CUSTOMER_INFO_AVAIL": 1,
"IS_SETTLED": "",
"IS_VOIDED": "",
"IS_REVERSED": "",
"DBA_NAME": "Valor Store LLC",
"CREATED_AT": "03/24/26 02:00 AM",
"EXPIRED_AT": "03/25/26",
"DAYS_UNTILL_EXPIRATION": 1,
"PAYMENT_AT": "03/24/26 02:01 AM",
"INVOICE_QB_PAYNOW": 0,
"INVOICE_QB": 0
}
]
}
Field Type Description statusstring OK on successmessagestring Success on successnumber_of_recordsinteger Number of records returned on this page page_numberinteger Current page number total_resultsinteger Total number of matching e-invoices page_sizeinteger Number of records per page total_pagesinteger Total number of pages available dataarray Array of e-invoice objects
Field Type Description IDinteger Internal e-invoice ID UIDstring Unique identifier for the payment link EPIstring Merchant terminal / EPI identifier INVOICE_MODEstring Invoice mode (e.g. EINVOICE) AMOUNT_TYPEstring Amount type — FIXED or FLEXIBLE AMOUNTstring Invoice amount TAXstring Tax amount, if specified TIPstring Tip amount, if specified SURCHARGEstring Surcharge amount, if applicable SURCHARGE_TYPEstring | null Surcharge type, if applicable SURCHARGE_INDICATORinteger 1 if surcharge is enabled; 0 otherwiseSURCHARGE_PERCENTAGEstring Surcharge percentage, if applicable ATTEMPTSinteger Number of payment attempts made CREATED_ONstring Invoice creation timestamp in YYYY-MM-DD HH:MM:SS format (UTC) NEVER_EXPIREinteger 1 if the invoice never expires; 0 otherwiseACTIVE_ONstring Invoice expiry datetime in YYYY-MM-DD HH:MM:SS format (UTC) STATUSstring Invoice status (e.g. PAID, PENDING, EXPIRED, CANCELED) CUSTOMER_NAMEstring Customer name, if provided INVOICE_NOstring Merchant-supplied invoice reference PRODUCT_DESCRIPTIONstring Description of the product or service SMS_STATUSinteger 1 if SMS notification was sent; 0 otherwiseTXN_IDinteger Transaction ID of the associated payment, if paid RRNstring Retrieval reference number of the payment, if paid PAYMENT_RECEIVED_ONstring Payment receipt timestamp in YYYY-MM-DD HH:MM:SS format (UTC) IS_QRCODEinteger 1 if this invoice was generated as a QR code; 0 otherwiseIS_CUSTOMER_INFO_AVAILinteger 1 if customer information is available; 0 otherwiseIS_SETTLEDstring 1 if settled; empty if not yet settledIS_VOIDEDstring 1 if voided; empty otherwiseIS_REVERSEDstring 1 if reversed; empty otherwiseDBA_NAMEstring Merchant doing-business-as name CREATED_ATstring Invoice creation timestamp in MM/DD/YY HH:MM AM/PM format EXPIRED_ATstring Invoice expiry date in MM/DD/YY format DAYS_UNTILL_EXPIRATIONinteger Days remaining until the invoice expires PAYMENT_ATstring Payment timestamp in MM/DD/YY HH:MM AM/PM format, if paid INVOICE_QB_PAYNOWinteger 1 if QuickBooks Pay Now is enabled; 0 otherwiseINVOICE_QBinteger 1 if QuickBooks integration is active; 0 otherwise
JSON
{
"error_no": "A26",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID DATE FILTER"
}
Field Type Description error_nostring A26 indicates an invalid date filter valuemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00 (via status: OK)Success E-invoice records returned A26Processing error Invalid or unsupported date_filter value
Look up card metadata using the first 6 digits (BIN) of a card number.
JSON
{
"error_no": "S00",
"pan_number": "411111",
"card_brand": "VISA",
"card_type": "D",
"desc": "SUCCESS"
}
Field Type Description error_nostring S00 indicates a successful lookuppan_numberstring The BIN submitted for lookup (first 6 digits) card_brandstring Card network (e.g. VISA, MASTERCARD) card_typestring Card type — D = Debit, C = Credit descstring Detailed description
JSON
{
"error_no": "G42",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID BIN"
}
Field Type Description error_nostring G42 indicates the BIN is invalid or not foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success BIN recognised and card metadata returned G42Processing error BIN is fewer than 6 digits, non-numeric, or not in the database
Retrieve store, device, and processor configuration details for a given terminal.
JSON
{
"error_no": "S00",
"store": {
"name": "Test Store",
"version_tid": "75021674",
"last_heartbeat": null
},
"device": {
"name": "VT #2",
"type": "Virtual Terminal",
"serial_no": null,
"last_txn_date": "2026-03-24 02:18:36",
"assigned_app_version": "1.0.0",
"app_update": "enabled",
"app_updated": null,
"param_update": "enabled",
"param_updated": null,
"status": "active",
"owner": "Valor ISO LLC"
},
"processor": {
"name": "TSYS SIERRA",
"Profiles": {
"Traditional": 0,
"Surcharge": 1
}
}
}
Field Type Description error_nostring S00 indicates a successful responsestoreobject Store-level information deviceobject Device-level information processorobject Payment processor configuration
Field Type Description namestring Store name version_tidstring Terminal ID associated with this store version last_heartbeatstring | null Timestamp of the last device heartbeat; null if never received
Field Type Description namestring Device label (e.g. VT #2) typestring Device type (e.g. Virtual Terminal, Physical Terminal) serial_nostring | null Device serial number; null for virtual terminals last_txn_datestring Timestamp of the last transaction processed on this device assigned_app_versionstring Currently assigned application version app_updatestring App update setting — enabled or disabled app_updatedstring | null Timestamp of the last app update; null if not yet updated param_updatestring Parameter update setting — enabled or disabled param_updatedstring | null Timestamp of the last parameter update; null if not yet updated statusstring Device status (e.g. active, inactive) ownerstring Name of the ISO or entity that owns this device
Field Type Description namestring Payment processor name (e.g. TSYS SIERRA) Profilesobject Enabled processing profiles. 1 = enabled, 0 = disabled Profiles.Traditionalinteger 1 if traditional processing is enabledProfiles.Surchargeinteger 1 if surcharge processing is enabled
JSON
{
"error_no": "D27",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID EPI ID"
}
Field Type Description error_nostring D27 indicates the EPI ID is invalid or not foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Device info returned D27Processing error EPI ID not found or invalid
Send a transaction e-receipt to a customer by email or SMS.
JSON
{
"error_no": "S00",
"status": "OK",
"msg": "SUCCESS",
"desc": "EMAIL SENT SUCCESSFULLY"
}
Field Type Description error_nostring S00 indicates the receipt was sent successfullystatusstring OK on successmsgstring SUCCESS on successdescstring Detailed description
JSON
{
"error_no": "91",
"status": "OK",
"msg": "PROCESSING ERROR",
"desc": "INVALID TXN ID"
}
Field Type Description error_nostring 91 indicates the transaction ID is invalid or not foundstatusstring OK is returned even on error for this response typemsgstring Error message descstring Detailed description
Note: This endpoint returns status: "OK" even when an error occurs. Use error_no to determine success or failure.
error_noMeaning Typical cause S00Success Receipt sent to the customer 91Processing error Transaction ID not found or invalid
Generate a QR code payment link for a given terminal.
JSON
{
"error_no": "S00",
"qr_code_url": "https://qr-staging.valorpaytech.com/qr_codes/qr_3279e75fZ8ULm***********vz0FZ901ee24710.png",
"uid": "Z8ULm***********vz0FZ9"
}
Field Type Description error_nostring S00 indicates the QR code was generated successfullyqr_code_urlstring Direct URL to the QR code image (PNG format) uidstring Unique identifier for this payment link
JSON
{
"error_no": "E68",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID NEVER EXPIRE"
}
Field Type Description error_nostring E68 indicates an invalid never_expire valuemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success QR code generated E68Processing error Invalid value provided for never_expire parameter
Retrieve the list of modifiers configured for a terminal.
JSON
{
"status": "OK",
"message": "Success",
"number_of_records": 1,
"data": [
{
"product_id": "193028",
"product_code": "SK002",
"item_name": "Apple 1",
"description": "Testproduct",
"quantity": "1",
"unit_cost": 10,
"taxable": "Yes",
"inventory": "Yes",
"precedence": "45755",
"category": "Fruites",
"group_name": "FOOD",
"is_active": "1",
"is_deleted": "0"
}
]
}
Field Type Description statusstring OK on successmessagestring Success on successnumber_of_recordsinteger Number of modifier records returned dataarray Array of modifier objects
Field Type Description product_idstring Unique modifier / product identifier product_codestring Merchant-assigned product SKU or code item_namestring Display name of the modifier item descriptionstring Description of the modifier item quantitystring Default quantity unit_costnumber Unit price of the modifier taxablestring Yes if taxable; No otherwiseinventorystring Yes if inventory tracking is enabled; No otherwiseprecedencestring Display sort order categorystring Category the modifier belongs to group_namestring Group the modifier belongs to is_activestring 1 if active; 0 if inactiveis_deletedstring 1 if deleted; 0 if not deleted
JSON
{
"error_no": "D07",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "NOT A VALID APP KEY"
}
error_noMeaning Typical cause S00 (via status: OK)Success Modifier list returned D07Processing error Invalid or unrecognised App Key
Add a new modifier item to the terminal's product catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "MODIFIER ADDED SUCCESSFULLY"
}
JSON
{
"error_no": "G11",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PRODUCT CODE ALREADY AVAILABLE"
}
error_noMeaning Typical cause S00Success Modifier created G11Processing error A modifier with the same product_code already exists
Update an existing modifier item in the terminal's product catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "PRODUCT UPDATED SUCCESSFULLY"
}
JSON
{
"error_no": "G20",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PRODUCT ID DOES NOT EXIST"
}
error_noMeaning Typical cause S00Success Modifier updated G20Processing error product_id does not exist
Soft-delete a modifier item from the terminal's product catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "PRODUCT DELETED SUCCESSFULLY"
}
JSON
{
"error_no": "G19",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PRODUCT IS ALREADY DELETED"
}
error_noMeaning Typical cause S00Success Modifier deleted G19Processing error Modifier is already in a deleted state
Retrieve the list of discounts configured for a terminal.
JSON
{
"status": "OK",
"message": "Success",
"number_of_records": 1,
"data": [
{
"discount_id": 1699,
"discount_name": "WelcomeOffer34",
"amount_type": 0,
"cost": "10.000%"
}
]
}
Field Type Description statusstring OK on successmessagestring Success on successnumber_of_recordsinteger Number of discount records returned dataarray Array of discount objects
Field Type Description discount_idinteger Unique discount identifier discount_namestring Display name of the discount amount_typeinteger Discount type — 0 = percentage, 1 = fixed amount coststring Discount value. Shown as "10.000%" for percentage discounts or a decimal for fixed discounts
JSON
{
"error_no": "D07",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "NOT A VALID APP KEY"
}
error_noMeaning Typical cause S00 (via status: OK)Success Discount list returned D07Processing error Invalid or unrecognised App Key
Add a new discount to the terminal's discount catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "DISCOUNT ADDED SUCCESSFULLY"
}
JSON
{
"error_no": "G14",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "DISCOUNT COST IS REQUIRED"
}
error_noMeaning Typical cause S00Success Discount created G14Processing error cost field is missing from the request
Update an existing discount in the terminal's discount catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "DISCOUNT UPDATED SUCCESSFULLY"
}
JSON
{
"error_no": "G43",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PERCENTAGE EXCEEDED"
}
error_noMeaning Typical cause S00Success Discount updated G43Processing error Percentage discount value exceeds 100%
Remove a discount from the terminal's discount catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "DISCOUNT DELETED SUCCESSFULLY"
}
JSON
{
"error_no": "G17",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "DISCOUNT IS DOES NOT EXIST OR IS ALREADY DELETED"
}
error_noMeaning Typical cause S00Success Discount deleted G17Processing error Discount ID not found or already in a deleted state
Retrieve the list of products configured for a terminal.
JSON
{
"status": "OK",
"message": "Success",
"number_of_records": 1,
"data": [
{
"product_id": 1375813,
"product_code": "Test",
"item_name": "Test",
"description": "Test",
"quantity": "0",
"unit_cost": 0,
"taxable": "Yes",
"inventory": "No",
"precedence": "1",
"category": "Test",
"is_active": "1",
"is_deleted": 0
}
]
}
Field Type Description statusstring OK on successmessagestring Success on successnumber_of_recordsinteger Number of product records returned dataarray Array of product objects
Field Type Description product_idinteger Unique product identifier product_codestring Merchant-assigned product SKU or code item_namestring Display name of the product descriptionstring Product description quantitystring Default quantity unit_costnumber Unit price of the product taxablestring Yes if taxable; No otherwiseinventorystring Yes if inventory tracking is enabled; No otherwiseprecedencestring Display sort order categorystring Category the product belongs to is_activestring 1 if active; 0 if inactiveis_deletedinteger 1 if deleted; 0 if not deleted
Add a new product to the terminal's product catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "PRODUCT ADDED SUCCESSFULLY"
}
JSON
{
"error_no": "G11",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PRODUCT CODE ALREADY AVAILABLE"
}
error_noMeaning Typical cause S00Success Product created G11Processing error A product with the same product_code already exists
Update an existing product in the terminal's product catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "PRODUCT UPDATED SUCCESSFULLY"
}
JSON
{
"error_no": "G12",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID PRODUCT ID"
}
error_noMeaning Typical cause S00Success Product updated G12Processing error product_id does not exist or is invalid
Soft-delete a product from the terminal's product catalogue.
JSON
{
"error_no": "S00",
"mesg": "SUCCESS",
"msg": "SUCCESS",
"desc": "PRODUCT DELETED SUCCESSFULLY"
}
JSON
{
"error_no": "G19",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PRODUCT IS ALREADY DELETED"
}
error_noMeaning Typical cause S00Success Product deleted G19Processing error Product is already in a deleted state
Create a new recurring subscription for a cardholder.
JSON
{
"error_no": "S00",
"error_code": "00",
"subscription_id": 47752,
"msg": "SUBSRIPTION_CREATED",
"desc": "Subsription has been created"
}
Field Type Description error_nostring S00 indicates the subscription was created successfullyerror_codestring Gateway error code. 00 = no error subscription_idinteger Unique identifier for the newly created subscription msgstring Result (e.g. SUBSRIPTION_CREATED) descstring Detailed description
JSON
{
"error_no": "A43",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "RECURRING TYPE MUST BE ALLOWERD 0, 1 AND 2"
}
Field Type Description error_nostring A43 indicates an invalid recurring type valuemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Subscription created A43Processing error recurring_type must be 0, 1, or 2
Update the details of an existing subscription.
JSON
{
"error_no": "S00",
"error_code": "00",
"msg": "SUBSRIPTION_EDITED",
"desc": "Subsription has been edited"
}
Field Type Description error_nostring S00 indicates the subscription was updated successfullyerror_codestring Gateway error code. 00 = no error msgstring Result (e.g. SUBSRIPTION_EDITED) descstring Detailed description
JSON
{
"error_no": "E76",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID SUBSCRIPTION ID"
}
Field Type Description error_nostring E76 indicates the subscription ID is invalid or not foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Subscription updated E76Processing error Subscription ID does not exist
Pause an active subscription, preventing future billing cycles from running.
JSON
{
"error_no": "S00",
"status": "OK",
"msg": "SUCCESS",
"desc": "SUBSCRIPTION DEACTIVATED SUCCESSFULLY"
}
Field Type Description error_nostring S00 indicates the subscription was deactivated successfullystatusstring OK on successmsgstring SUCCESS on successdescstring Detailed description
JSON
{
"error_no": "E64",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "SUBSCRIPTION ID MUST BE AN INTEGER"
}
Field Type Description error_nostring E64 indicates the subscription ID is not a valid integermesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Subscription deactivated E64Processing error subscription_id must be a valid integer
Re-activate a previously deactivated subscription to resume billing cycles.
JSON
{
"error_no": "S00",
"status": "OK",
"msg": "SUCCESS",
"desc": "SUBSCRIPTION ACTIVATED SUCCESSFULLY"
}
Field Type Description error_nostring S00 indicates the subscription was activated successfullystatusstring OK on successmsgstring SUCCESS on successdescstring Detailed description
JSON
{
"error_no": "E65",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "SUBSCRIPTION IS ALREADY COMPLETED"
}
Field Type Description error_nostring E65 indicates the subscription has already run to completionmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Subscription activated E65Processing error Subscription has already completed all billing cycles and cannot be reactivated
Permanently delete a subscription record.
JSON
{
"error_no": "S00",
"status": "OK",
"msg": "SUCCESS",
"desc": "SUBSCRIPTION DELETED SUCCESSFULLY"
}
Field Type Description error_nostring S00 indicates the subscription was deleted successfullystatusstring OK on successmsgstring SUCCESS on successdescstring Detailed description
JSON
{
"error_no": "E62",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "SUBSCRIPTION ALREADY DELETED"
}
Field Type Description error_nostring E62 indicates the subscription is already in a deleted statemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Subscription deleted E62Processing error Subscription has already been deleted
Submit an ACH (bank transfer) payment for processing.
JSON
{
"status": "WAITING",
"mesg": "Waiting for Giact Approval",
"msg": "WAITING",
"error_no": "S00",
"amount": "0.01",
"state_tax": "0",
"epi": "2319916062",
"routing_number": "****0021",
"account_number": "****0510",
"check_number": null,
"document_id": null,
"entry_class": null,
"received_on": null,
"posting_date": null,
"current_state": "Pending",
"desc": null,
"verification_status": "WAITING",
"reference_number": "69c25b4a3a9a6"
}
Field Type Description error_nostring S00 indicates the ACH transaction was submitted successfullystatusstring Processing status (e.g. WAITING, APPROVED) msgstring Status message mesgstring Detailed status message from the processor amountstring Transaction amount in decimal format state_taxstring State tax amount, if applicable epistring Merchant terminal / EPI identifier routing_numberstring Masked bank routing number (last 4 digits shown) account_numberstring Masked bank account number (last 4 digits shown) check_numberstring | null Check number, if applicable document_idstring | null Document identifier, if applicable entry_classstring | null ACH entry class code (e.g. CCD, PPD), populated after processing received_onstring | null Timestamp when the transaction was received by the bank posting_datestring | null Date the transaction will post to the account current_statestring Current transaction state (e.g. Pending, Settled) descstring | null Detailed description verification_statusstring Bank verification status (e.g. WAITING, Authorized) reference_numberstring Unique reference number for this ACH transaction
Note: ACH transactions are not immediately approved. The initial response returns status: "WAITING" while awaiting bank verification. Poll the transaction status or use webhooks to track final settlement.
JSON
{
"error_no": "A02",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "ROUTING NUMBER IS INVALID"
}
Field Type Description error_nostring A02 indicates an invalid routing numbermesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Submitted ACH transaction accepted and pending verification A02Processing error Routing number is invalid or not found
Void a pending ACH transaction before it is processed by the bank.
JSON
{
"error_no": "S00",
"msg": "APPROVED",
"mesg": "APPROVED",
"epi": "2319916062",
"desc": "VOIDED SUCCESSFULLY",
"reference_number": "69c25b4a3a9a6"
}
Field Type Description error_nostring S00 indicates the ACH void was successfulmsgstring APPROVED on successmesgstring APPROVED on successepistring Merchant terminal / EPI identifier descstring Detailed description reference_numberstring Reference number of the voided ACH transaction
JSON
{
"error_no": "A19",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "TRANSACTION COULD NOT BE FOUND OR HAS ALREADY BEEN VOIDED"
}
Field Type Description error_nostring A19 indicates the transaction cannot be voidedmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved ACH transaction voided successfully A19Processing error Transaction not found or already voided
Create a recurring ACH payment schedule for a customer.
JSON
{
"error_no": "S00",
"msg": "APPROVED",
"mesg": "APPROVED",
"amount": "0.01",
"state_tax": "0",
"epi": "2319916062",
"desc": "ACH RECURRING SALE CREATED",
"next_execution_date": "2026-09-25",
"reference_number": "69c25b96206d0"
}
Field Type Description error_nostring S00 indicates the recurring schedule was created successfullymsgstring APPROVED on successmesgstring APPROVED on successamountstring Recurring charge amount in decimal format state_taxstring State tax amount, if applicable epistring Merchant terminal / EPI identifier descstring Detailed description next_execution_datestring Date of the next scheduled payment in YYYY-MM-DD format reference_numberstring Unique identifier (UID) for this recurring schedule
JSON
{
"error_no": "A04",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "PAYEE NAME IS INVALID"
}
Field Type Description error_nostring A04 indicates an invalid payee namemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Recurring ACH schedule created A04Processing error Payee name is missing, invalid, or contains unsupported characters
Update the details of an existing recurring ACH payment schedule.
JSON
{
"error_no": "S00",
"msg": "WAITING",
"mesg": "Waiting for file to be uploaded",
"desc": "ACH RECURRING EDIT SUCCESSFULLY COMPLETED",
"next_execution_date": "2026-09-25",
"reference_number": "69c25b96206d0",
"epi": "2319916062",
"amount": "0.01"
}
Field Type Description error_nostring S00 indicates the recurring schedule was updated successfullymsgstring Processing status (e.g. WAITING) mesgstring Detailed status message from the processor descstring Detailed description next_execution_datestring Date of the next scheduled payment in YYYY-MM-DD format reference_numberstring UID for this recurring schedule epistring Merchant terminal / EPI identifier amountstring Updated recurring charge amount in decimal format
JSON
{
"error_no": "A18",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID UID"
}
Field Type Description error_nostring A18 indicates the UID is invalid or not foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Recurring schedule updated A18Processing error UID does not exist or is not associated with an active recurring schedule
Activate a previously deactivated recurring ACH payment schedule.
JSON
{
"error_no": "S00",
"uid": "69c25b96206d0",
"msg": "ACH Recurring Billing Activated Successfully",
"mesg": "Recurring ACH payments have been Activated."
}
Field Type Description error_nostring S00 indicates the schedule was activated successfullyuidstring UID of the recurring schedule msgstring Short confirmation message mesgstring Detailed confirmation message
JSON
{
"error_no": "A74",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "ACH RECURRING ID IS ALREADY ACTIVATED"
}
Field Type Description error_nostring A74 indicates the recurring schedule is already activemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Recurring schedule activated A74Processing error Schedule is already in an active state
Deactivate an active recurring ACH payment schedule to pause future billing.
JSON
{
"error_no": "S00",
"uid": "69c25b96206d0",
"msg": "ACH Recurring Billing Deactivated Successfully",
"mesg": "Recurring ACH payments have been Deactivated."
}
Field Type Description error_nostring S00 indicates the schedule was deactivated successfullyuidstring UID of the recurring schedule msgstring Short confirmation message mesgstring Detailed confirmation message
JSON
{
"error_no": "A75",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "ACH RECURRING ID IS ALREADY DEACTIVATED"
}
Field Type Description error_nostring A75 indicates the recurring schedule is already inactivemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Recurring schedule deactivated A75Processing error Schedule is already in a deactivated state
Skip the next scheduled ACH payment in a recurring billing schedule.
JSON
{
"error_no": "S00",
"uid": "69c25b96206d0",
"remaining_payments": 5,
"msg": "Next ACH Payment Skipped Successfully",
"mesg": "Payments remaining: 5"
}
Field Type Description error_nostring S00 indicates the next payment was skipped successfullyuidstring UID of the recurring schedule remaining_paymentsinteger Number of payments remaining after the skip msgstring Short confirmation message mesgstring Detailed confirmation message including remaining count
JSON
{
"error_no": "A76",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "ACH SKIP NEXT PAYMENT ALREADY ENABLED"
}
Field Type Description error_nostring A76 indicates a skip is already pending for the next paymentmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Next payment skipped A76Processing error A skip for the next payment is already enabled
Postpone the next scheduled ACH payment by a specified duration.
JSON
{
"error_no": "S00",
"uid": "69c******5b23",
"remaining_payments": 6,
"msg": "ACH Payment Postponed Successfully",
"mesg": "Postponed by 1 WEEK. Payments remaining: 6"
}
Field Type Description error_nostring S00 indicates the payment was postponed successfullyuidstring UID of the recurring schedule remaining_paymentsinteger Number of payments remaining after the postponement msgstring Short confirmation message mesgstring Detailed confirmation including postponement duration and remaining count
JSON
{
"error_no": "A77",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "ACH POSTPONE NEXT PAYMENT ALREADY ENABLED"
}
Field Type Description error_nostring A77 indicates a postponement is already pending for the next paymentmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Next payment postponed A77Processing error A postponement for the next payment is already enabled
Retrieve a list of ACH transactions for a given terminal.
JSON
{
"records": 1,
"data": [
{
"platform": "Test",
"uid": "67cb29eac5a56",
"epi": "2319916062",
"amount": "5.87",
"account_number": "****0510",
"routing_number": "****0021",
"current_state": "Settled",
"entry_class": "CCD",
"batch_number": "14238052",
"txn_date": "2025-03-07 17:16:26",
"posting_date": "",
"deleted": "NO",
"verification_status": "Authorized",
"vs_line1": "RVD/PLUS VERIFY",
"vs_line2": "AUTH NUM: 10024648C",
"vs_line3": "RVD MESSAGE: ",
"TOTAL_COUNT": "4",
"invoice_no": "Test",
"txn_type": "Debit",
"tip_amount": "0",
"tax": "0",
"fee": "0",
"payee_name": "ABU",
"base_amount": "5.87",
"account_type": "Checking",
"recurring_id": "0",
"company_name": "ValorPay Test",
"email_id": "[email protected] ",
"phone_number": "1111111111",
"ach_id": "",
"vault_id": "",
"ach_auth_upload_status": ""
}
]
}
Field Type Description recordsinteger Number of ACH transaction records returned dataarray Array of ACH transaction objects
Field Type Description platformstring Processing platform name, if applicable uidstring Unique identifier for this ACH transaction epistring Merchant terminal / EPI identifier amountstring Transaction amount in decimal format account_numberstring Masked bank account number (last 4 digits shown) routing_numberstring Masked bank routing number (last 4 digits shown) current_statestring Current transaction state (e.g. Pending, Settled, Returned) entry_classstring ACH entry class code (e.g. CCD, PPD, WEB) batch_numberstring ACH batch number txn_datestring Transaction creation timestamp in YYYY-MM-DD HH:MM:SS format posting_datestring Date the transaction posted to the bank account deletedstring YES if the record is deleted; NO otherwiseverification_statusstring Bank verification status (e.g. Authorized, WAITING) vs_line1string Verification service response line 1 vs_line2string Verification service response line 2 (includes auth number) vs_line3string Verification service response line 3 TOTAL_COUNTstring Total number of ACH transactions for this terminal invoice_nostring Invoice reference, if provided txn_typestring Transaction type — Debit or Credit tip_amountstring Tip amount in decimal format taxstring Tax amount in decimal format feestring Fee amount in decimal format payee_namestring Name of the payee base_amountstring Base transaction amount in decimal format account_typestring Bank account type (e.g. Checking, Savings) recurring_idstring Recurring schedule ID, if this transaction is part of a recurring plan; 0 otherwise company_namestring Company name associated with the transaction email_idstring Customer email address, if provided phone_numberstring Customer phone number, if provided ach_idstring Internal ACH identifier vault_idstring Vault record identifier, if applicable ach_auth_upload_statusstring Upload status of the ACH authorization document
JSON
{
"error_no": "A24",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID OFFSET"
}
Field Type Description error_nostring A24 indicates an invalid pagination offset valuemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00 (via records count)Success ACH transaction records returned A24Processing error Invalid or out-of-range offset pagination parameter
Retrieve a list of recurring ACH payment schedules for a given terminal.
JSON
{
"records": 1,
"data": [
{
"platform": "Acheck21",
"uid": "69c******5b23",
"txn_type": "Debit",
"epi": "2319916062",
"amount": "0.01",
"account_number": "****0510",
"routing_number": "****0021",
"payee_name": "John Smith",
"account_type": "Checking",
"TOTAL_COUNT": "30",
"is_deleted": "0",
"deleted_on": null,
"invoice_no": "Test",
"entry_class": "CCD",
"email_id": "[email protected] ",
"phone_number": "1111111111",
"recurring_type": "Subscription",
"status": "Active",
"start_from": "2026-09-25",
"billing_expire": "6",
"frequency_type": "weekly",
"frequency_string": "3",
"created_on": "2026-03-24 09:45:11",
"next_execution_date": "2026-10-02",
"last_executed_date": null,
"total_run_count": "0",
"success_run_count": "0",
"failure_run_count": "0"
}
]
}
Field Type Description recordsinteger Number of recurring schedule records returned dataarray Array of recurring ACH schedule objects
Field Type Description platformstring Processing platform name uidstring Unique identifier for this recurring schedule txn_typestring Transaction type — Debit or Credit epistring Merchant terminal / EPI identifier amountstring Recurring charge amount in decimal format account_numberstring Masked bank account number (last 4 digits shown) routing_numberstring Masked bank routing number (last 4 digits shown) payee_namestring Name of the payee account_typestring Bank account type (e.g. Checking, Savings) TOTAL_COUNTstring Total number of recurring schedules for this terminal is_deletedstring 1 if deleted; 0 otherwisedeleted_onstring | null Deletion timestamp, if deleted invoice_nostring Invoice reference, if provided entry_classstring ACH entry class code (e.g. CCD, PPD) email_idstring Customer email address, if provided phone_numberstring Customer phone number, if provided recurring_typestring Recurring type (e.g. Subscription, Installment) statusstring Schedule status (e.g. Active, Inactive) start_fromstring Start date of the recurring schedule in YYYY-MM-DD format billing_expirestring Number of billing cycles before expiry frequency_typestring Billing frequency (e.g. weekly, monthly, daily) frequency_stringstring Frequency interval (e.g. 3 = every 3 weeks) created_onstring Schedule creation timestamp in YYYY-MM-DD HH:MM:SS format next_execution_datestring Date of the next scheduled payment in YYYY-MM-DD format last_executed_datestring | null Date of the last successfully executed payment; null if none yet total_run_countstring Total number of billing attempts made success_run_countstring Number of successful billing attempts failure_run_countstring Number of failed billing attempts
JSON
{
"error_no": "A32",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID STATUS"
}
Field Type Description error_nostring A32 indicates an invalid status filter valuemesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00 (via records count)Success Recurring schedule records returned A32Processing error Invalid value provided for the status filter parameter
Permanently delete a recurring ACH payment schedule.
JSON
{
"error_no": "S00",
"uid": "69c******5b23",
"msg": "RECORD DELETED SUCCESSFULLY",
"mesg": "RECORD DELETED SUCCESSFULLY"
}
Field Type Description error_nostring S00 indicates the recurring schedule was deleted successfullyuidstring UID of the deleted recurring schedule msgstring RECORD DELETED SUCCESSFULLY on successmesgstring RECORD DELETED SUCCESSFULLY on success
JSON
{
"error_no": "A18",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID UID"
}
Field Type Description error_nostring A18 indicates the UID is invalid or not foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Recurring schedule deleted A18Processing error UID does not exist
Send an ACH authorization reminder to the customer.
JSON
{
"error_no": "S00",
"msg": "REMINDER SENT SUCCESSFULLY",
"desc": "ACH AUTHORIZATION REMINDER SENT SUCCESSFULLY",
"ach_id": 1376,
"reference_number": "gUY8g********kckjO7sl",
"dba_name": "Test"
}
Field Type Description error_nostring S00 indicates the authorization reminder was sent successfullymsgstring Short confirmation message descstring Detailed description ach_idinteger Internal ACH authorization record ID reference_numberstring Unique reference number for this authorization request dba_namestring Merchant doing-business-as name shown in the reminder
JSON
{
"error_no": "A05",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "NO VENDOR FOUND"
}
Field Type Description error_nostring A05 indicates no matching vendor/merchant record was foundmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Authorization reminder sent A05Processing error No vendor record found for the provided credentials
Process a sale transaction using a gift card.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "5.00",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"desc": null,
"additional_info": null,
"clerk_id": null,
"clerk_name": null,
"clerk_label": null,
"additionalKeyOne": null,
"additionalKeyTwo": null,
"additionalValueOne": null,
"additionalValueTwo": null,
"approval_code": "000000",
"rrn": "006083059013",
"txnid": "10169997",
"created_date": "24/03/2026",
"created_time": "05:53:09",
"tran_no": 2,
"stan": 687764,
"batch_no": 184,
"is_partial_approve": 0,
"partial_amount": "000000000500",
"pan": "XXXX1778",
"card_type": null,
"phone_number": "1111111111",
"email_id": "[email protected] ",
"zip": null,
"card_holder_name": null,
"expiry_date": "/",
"address": null,
"epi": "2319916062",
"channel": "VT",
"orderdescription": null,
"invoicenumber": null,
"token": "11FD46************2A9A9E",
"card_brand": null,
"netamt": 5
}
Field Type Description error_nostring S00 indicates a successful gift card salesuccess_urlboolean true when the transaction is approvederror_codestring Gateway error code. 00 = no error amountstring Charged amount in decimal format taxstring Tax amount, if applicable customfeestring Custom fee, if applicable msgstring Result (e.g. APPROVED) approval_codestring Issuer-returned authorization code. Gift cards typically return 000000 rrnstring Retrieval reference number for reconciliation txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number within the batch staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full approvalpartial_amountstring Approved amount in zero-padded 12-digit format panstring Masked gift card number — last 4 digits shown email_idstring Customer email address, if provided expiry_datestring Returns "/" as gift cards typically do not have an expiry date epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. VT) netamtnumber Net amount charged
JSON
{
"error_no": "E98",
"error_code": "92",
"success_url": false,
"txnid": "10169994",
"batch_no": 583,
"switch_error_code": "V0611",
"mesg": "Routing Error",
"desc": "Error code :92",
"msg": "Routing Error",
"isFlexSendOrNot": "V0611"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Decline code (e.g. 92 = routing error) success_urlboolean Always false for declined transactions txnidstring Transaction identifier batch_nointeger Settlement batch identifier switch_error_codestring Switch-level error code mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator; mirrors switch_error_code
JSON
{
"error_no": "E26",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "AUTHENTICATION FAILED"
}
Field Type Description error_nostring E26 indicates an authentication failuremesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Gift card sale successful E98Declined E98 indicates a declined transactionE26Processing error Authentication credentials are invalid
Check the remaining balance on a gift card.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "4774.18",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"approval_code": "000000",
"rrn": "006083059015",
"txnid": null,
"created_date": "24/03/2026",
"created_time": "05:53:47",
"tran_no": 3,
"stan": 687766,
"batch_no": 184,
"is_partial_approve": 0,
"partial_amount": "000000000000",
"pan": "XXXX1778",
"epi": "2319916062",
"channel": "VT",
"netamt": 4774.18
}
Field Type Description error_nostring S00 indicates a successful balance inquirysuccess_urlboolean true when the inquiry is approvederror_codestring Gateway error code. 00 = no error amountstring Current balance on the gift card in decimal format msgstring Result (e.g. APPROVED) approval_codestring Authorization code. Returns 000000 for balance checks rrnstring Retrieval reference number txnidstring | null Not applicable for balance checks; returns null created_datestring Inquiry date in DD/MM/YYYY format created_timestring Inquiry time in HH:MM:SS format tran_nointeger Sequential transaction number staninteger System trace audit number batch_nointeger Batch identifier partial_amountstring Returns 000000000000 for balance checks panstring Masked gift card number — last 4 digits shown epistring Merchant terminal / EPI identifier channelstring Transaction channel netamtnumber Current gift card balance
JSON
{
"error_no": "E98",
"error_code": "VR",
"success_url": false,
"txnid": null,
"batch_no": 184,
"switch_error_code": "V00VR",
"mesg": "CARD NOT FOUND",
"desc": "Error code :VR",
"msg": "CARD NOT FOUND",
"isFlexSendOrNot": "V00VR"
}
JSON
{
"error_no": "E06",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID CARD NUMBER"
}
error_noMeaning Typical cause S00Approved Balance returned successfully E98Declined E98 indicates a declined transactionE06Processing error Invalid or malformed card number
Activate a gift card so it can be used for purchases.
JSON
{
"error_no": "E98",
"error_code": "VR",
"success_url": false,
"txnid": null,
"batch_no": 184,
"switch_error_code": "V00VR",
"mesg": "ALREADY ACTIVE",
"desc": "Error code :VR",
"msg": "ALREADY ACTIVE",
"isFlexSendOrNot": "V00VR"
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Decline code (e.g. VR = already active) success_urlboolean Always false for declined operations txnidstring | null Not applicable; returns null batch_nointeger Batch identifier switch_error_codestring Switch-level error code mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring Flex routing indicator
JSON
{
"error_no": "E98",
"error_code": "VI",
"success_url": false,
"txnid": null,
"batch_no": 0,
"switch_error_code": null,
"mesg": "CARD NOT FOUND",
"desc": "Error code :VI",
"msg": "CARD NOT FOUND",
"isFlexSendOrNot": null
}
JSON
{
"error_no": "E06",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "INVALID CARD NUMBER"
}
error_noMeaning Typical cause S00Approved Gift card activated successfully E98 (VR)Declined E98 indicates a declined transactionE98 (VI)Declined E98 indicates a declined transactionE06Processing error Invalid or malformed card number
Add funds to an existing gift card.
JSON
{
"error_no": "S00",
"success_url": true,
"error_code": "00",
"amount": "10.00",
"tax": "0.01",
"customfee": "0.01",
"msg": "APPROVED",
"desc": null,
"additional_info": null,
"approval_code": "000000",
"rrn": "006083059022",
"txnid": "10170024",
"created_date": "24/03/2026",
"created_time": "05:55:28",
"tran_no": 3,
"stan": 687775,
"batch_no": 184,
"is_partial_approve": 0,
"partial_amount": "000000001000",
"pan": "XXXX1778",
"card_type": null,
"epi": "2319916062",
"channel": "VT",
"netamt": 10
}
Field Type Description error_nostring S00 indicates funds were added successfullysuccess_urlboolean true when the transaction is approvederror_codestring Gateway error code. 00 = no error amountstring Amount added to the gift card in decimal format taxstring Tax amount, if applicable customfeestring Custom fee, if applicable msgstring Result (e.g. APPROVED) approval_codestring Authorization code. Returns 000000 for gift card transactions rrnstring Retrieval reference number txnidstring Unique transaction identifier created_datestring Transaction date in DD/MM/YYYY format created_timestring Transaction time in HH:MM:SS format tran_nointeger Sequential transaction number staninteger System trace audit number batch_nointeger Settlement batch identifier is_partial_approveinteger 1 if partially approved; 0 for full amountpartial_amountstring Amount added in zero-padded 12-digit format panstring Masked gift card number — last 4 digits shown epistring Merchant terminal / EPI identifier channelstring Transaction channel (e.g. ECOMM) netamtnumber Net amount added to the gift card
JSON
{
"error_no": "E98",
"error_code": "VI",
"success_url": false,
"txnid": null,
"batch_no": 0,
"switch_error_code": null,
"mesg": "CARD NOT FOUND",
"desc": "Error code :VI",
"msg": "CARD NOT FOUND",
"isFlexSendOrNot": null
}
Field Type Description error_nostring E98 indicates a declined transactionerror_codestring Decline code (e.g. VI = card not found) success_urlboolean Always false for declined transactions txnidstring | null Not applicable; returns null batch_nointeger Batch identifier. Returns 0 when card is not found switch_error_codestring | null Switch-level error code; null when not available mesgstring Error message msgstring Error message descstring Detailed description isFlexSendOrNotstring | null Flex routing indicator; null when not available
JSON
{
"error_no": "D04",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "AMOUNT IS REQUIRED"
}
Field Type Description error_nostring D04 indicates a missing required amount fieldmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Approved Funds added to gift card successfully E98Declined E98 indicates a declined transactionD04Processing error amount field is missing from the request
Retrieve encrypted card data and tokenization details for a transaction or vault payment profile. Used to obtain encrypted card data for downstream processing integrations.
JSON
{
"error_no": "S00",
"error_code": "00",
"data": {
"cardholder_name": "John Smith",
"masked_pan": "XXXX1111",
"token": "D3DFB7*******5E5980D7",
"card_type": "C",
"card_brand": "Visa",
"spx_encrypted_pan": "adjsahdywer*******7w8e4guw37bgu",
"spx_iso_key_label": "ISO_SPX",
"spx_iso_session_key": "adjsahdywer*******7w8e4guw37bgu",
"customer_name": "TestACH"
}
}
Field Type Description error_nostring S00 indicates the data was retrieved successfullyerror_codestring Gateway error code. 00 = no error dataobject Encrypted card and profile data (see below)
Field Type Description cardholder_namestring Name on the card masked_panstring Masked card number — last 4 digits shown (e.g. XXXX1111) tokenstring card token associated with this card card_typestring Card type — C = Credit, D = Debit card_brandstring Card network (e.g. Visa, Mastercard) spx_encrypted_panstring SPX-encrypted card PAN for downstream processing spx_iso_key_labelstring ISO key label used for SPX encryption (e.g. ISO_SPX) spx_iso_session_keystring SPX ISO session key used to decrypt spx_encrypted_pan customer_namestring Customer name from the vault profile, if linked
JSON
{
"error_no": "D47",
"mesg": "PROCESSING ERROR",
"msg": "PROCESSING ERROR",
"desc": "MISSING REQUIRED PARAMETERS: TXN_ID OR VAULT_ID AND PAYMENT_ID"
}
Field Type Description error_nostring D47 indicates required parameters are missing from the requestmesgstring Error message msgstring Error message descstring Detailed description
error_noMeaning Typical cause S00Success Encrypted card data returned D47Processing error Request must include either txn_id, or both vault_id and payment_id
