This allows you to accept and verify a cardholder's payment information without actually billing the customer for a charge.
\nThis type of authorization request is particularly useful for a trial period for a product or service.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n*{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n\nBody parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"VERIFY\").\n\n\"*order\": Information about the order associated with this transaction.\n\n\"*amount\": The total amount for the order. This is the net amount plus any surcharge. The value of this field in the response may be zero if payer funds are not transferred. (Validation Rules: Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number. JSON type String, minimum length 1, maximum length 14).\n\n\"*currency\": The currency of the order expressed as an ISO 4217 alpha code, e.g. USD. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 3, maximum length 3).\n\n\"*reference\": The identifier of the order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\n\"*sourceOfFunds\": The details describing the source of the funds to be used.\n\n\"*provided\": Information about the source of funds when it is directly provided.\n\n\"*card\": The account number of the payer's card used for the payment.\n\n\"*number\": The account number embossed onto the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 9, maximum length 19).\n\n\"*expiry\": Expiry date, as shown on the card.\n\n\"*month\": Month, as shown on the card. Months are numbered January=1, through to December=12.(Validation Rules: Data is a number between 1 and 12 represented as a string. JSON type String).\n\n\"*year\": Year, as shown on the card. The Common Era year is 2000 plus this value. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 2, maximum length 2).\n\n\"securityCode\": Card verification code, as printed on the back or front of the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 3, maximum length 4).\n\n\"*type\": The payment method used for this payment. (Validation Rules: JSON type String, \"CARD\").\n\n\"*transaction\": Information about this transaction.\n\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40.\n\n\n{\n \"apiOperation\": \"VERIFY\",\n \"order\": {\n \"amount\": \"1.00\",\n \"currency\": \"EGP\",\n \"reference\": \"OPT-REF01\"\n },\n \"sourceOfFunds\": {\n \"provided\": {\n \"card\": {\n \"number\": \"597823xxxxxx7867\",\n \"expiry\": {\n \"month\": \"01\",\n \"year\": \"29\"\n },\n \"securityCode\": \"100\"\n }\n },\n \"type\": \"CARD\"\n },\n \"transaction\": {\n \"reference\": \"PTVe-REF01\"\n }\n}\n\nThis is an approval that the customer has sufficient funds on their card to pay for the transaction.
\nWhenever a transaction is made with a credit or debit card, the merchant sends a authorization request.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n*{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\nBody parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"AUTHORIZE\").\n\"*order\": Information about the order associated with this transaction.\n\"*amount\": The total amount for the order. This is the net amount plus any surcharge. The value of this field in the response may be zero if payer funds are not transferred. (Validation Rules: Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number. JSON type String, minimum length 1, maximum length 14).\n\"*currency\": The currency of the order expressed as an ISO 4217 alpha code, e.g. USD. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 3, maximum length 3).\n\"*reference\": The identifier of the order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\"*sourceOfFunds\": The details describing the source of the funds to be used.\n\"*provided\": Information about the source of funds when it is directly provided.\n\"*card\": The account number of the payer's card used for the payment.\n\"*number\": The account number embossed onto the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 9, maximum length 19).\n\"*expiry\": Expiry date, as shown on the card.\n\"*month\": Month, as shown on the card. Months are numbered January=1, through to December=12.(Validation Rules: Data is a number between 1 and 12 represented as a string. JSON type String).\n\"*year\": Year, as shown on the card. The Common Era year is 2000 plus this value.(Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 2, maximum length 2).\n\"securityCode\": Card verification code, as printed on the back or front of the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 3, maximum length 4).\n\"*type\": The payment method used for this payment. (Validation Rules: JSON type String, \"CARD\").\n\"*transaction\": Information about this transaction.\n\"*source\": Indicates the source through which you received the transaction. (Validation Rules: JSON type String, \"INTERNET\").\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40.\n----------Optional for external 3DS----------\n\"*authentication.3ds.authenticationToken\": Base64 encoded value generated by the issuer, used to verify the validity of the authentication. (Validation Rules: Base64, Length: 28 or 32).\n\"*authentication.3ds.transactionId\": A unique identifier for the 3-D Secure authentication transaction. (Validation Rules: String, Min Length: 1, Max Length: 50).\n\"*authentication.3ds\": Information on payer authentication using 3-D Secure authentication.\n\"*authentication\": Details about how the payer’s identity is verified (e.g., using 3-D Secure).\n\"*authentication.3ds.acsEci\": Indicates the security level of the transaction, provided by the issuer's Access Control Server (ACS). (Validation Rules: Alphanumeric, Min Length: 1, Max Length: 2).\n\"*authentication.3ds2\": Information on payer authentication using 3-D Secure version 2.\n\"*authentication.3ds2.protocolVersion\": The version of the EMV 3-D Secure protocol used. (Validation Rules: Alphanumeric + additional characters, Min Length: 1, Max Length: 20).\n\"*authentication.3ds2.statusReasonCode\": A code indicating the reason for the transaction status. (Validation Rules: String, Min Length: 2, Max Length: 2).\n\"*authentication.3ds2.transactionStatus\": Indicates the result of payer authentication. (Validation Rules: Alpha, Min Length: 1, Max Length: 1).\n\"*authentication.amount\": The amount for which the payer authentication was performed. (Validation Rules: Decimal, Min Length: 1, Max Length: 14). (Optional)\n\"*authentication.time\": The date and time when the payer authentication was performed in ISO8601 format. (Validation Rules: DateTime). (Optional)\n\n{\n \"apiOperation\": \"AUTHORIZE\",\n \"correlationId\": \"TEST64995566\",\n \"authentication\": {\n \"3ds\": {\n \"acsEci\": \"05\",\n \"authenticationToken\": \"AJkBBXaIQwAAAABkQEBTdRH4eiQ=\",\n \"transactionId\": \"f74b1ad4-7f14-4e35-9941-23cc11f87a24\"\n },\n \"3ds2\": {\n \"protocolVersion\": \"3DS2\",\n \"transactionStatus\": \"Y\",\n \"statusReasonCode\": \"01\"\n },\n \"amount\": \"1\",\n \"time\": \"2025-02-22T11:53:02.887Z\"\n },\n \"order\": {\n \"amount\": \"1\",\n \"currency\": \"EGP\",\n \"reference\": \"TEST64995566\"\n },\n \"sourceOfFunds\": {\n \"provided\": {\n \"card\": {\n \"number\": \"4012000033330026\",\n \"expiry\": {\n \"month\": \"01\",\n \"year\": \"39\"\n },\n \"securityCode\": \"100\"\n }\n },\n \"type\": \"CARD\"\n },\n \"transaction\": {\n \"source\": \"INTERNET\",\n \"reference\": \"PT-TEST64995566\"\n }\n}\n\nThis is an approval that the customer has sufficient funds on their card to pay for the transaction.
\nWhenever a transaction is made with a credit or debit card, the merchant sends a authorization request.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n*{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\nBody parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"AUTHORIZE\").\n\"*order\": Information about the order associated with this transaction.\n\"*amount\": The total amount for the order. This is the net amount plus any surcharge. The value of this field in the response may be zero if payer funds are not transferred. (Validation Rules: Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number. JSON type String, minimum length 1, maximum length 14).\n\"*currency\": The currency of the order expressed as an ISO 4217 alpha code, e.g. USD. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 3, maximum length 3).\n\"*reference\": The identifier of the order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\"*sourceOfFunds\": The details describing the source of the funds to be used.\n\"*provided\": Information about the source of funds when it is directly provided.\n\"*card\": The account number of the payer's card used for the payment.\n\"*number\": The account number embossed onto the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 9, maximum length 19).\n\"*expiry\": Expiry date, as shown on the card.\n\"*month\": Month, as shown on the card. Months are numbered January=1, through to December=12.(Validation Rules: Data is a number between 1 and 12 represented as a string. JSON type String).\n\"*year\": Year, as shown on the card. The Common Era year is 2000 plus this value.(Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 2, maximum length 2).\n\"securityCode\": Card verification code, as printed on the back or front of the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 3, maximum length 4).\n\"*type\": The payment method used for this payment. (Validation Rules: JSON type String, \"CARD\").\n\"*transaction\": Information about this transaction.\n\"*source\": Indicates the source through which you received the transaction. (Validation Rules: JSON type String, \"INTERNET\").\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40.\n\n{\n \"apiOperation\": \"AUTHORIZE\",\n \"order\": {\n \"amount\": \"1.00\",\n \"currency\": \"EGP\",\n \"reference\": \"OPT-REF01\"\n },\n \"sourceOfFunds\": {\n \"provided\": {\n \"card\": {\n \"number\": \"597823xxxxxx7867\",\n \"expiry\": {\n \"month\": \"01\",\n \"year\": \"29\"\n },\n \"securityCode\": \"100\"\n }\n },\n \"type\": \"CARD\"\n },\n \"transaction\": {\n \" source\": \"INTERNET\",\n \"reference\": \"PTVe-REF01\"\n }\n}\n\nThis refers to a transaction in which a purchase is made using a credit or debit card, but the 3D Secure (3DS) authentication protocol is not utilized for additional security.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{mid}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n*{flwref}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\nBody parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"PAY\").\n\"*order\": Information about the order associated with this transaction.\n\"*amount\": The total amount for the order. This is the net amount plus any surcharge. The value of this field in the response may be zero if payer funds are not transferred. (Validation Rules: Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number. JSON type String, minimum length 1, maximum length 14).\n\"*currency\": The currency of the order expressed as an ISO 4217 alpha code, e.g. USD. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 3, maximum length 3).\n\"*reference\": The identifier of the order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\"*sourceOfFunds\": The details describing the source of the funds to be used.\n\"*provided\": Information about the source of funds when it is directly provided.\n\"*card\": The account number of the payer's card used for the payment.\n\"*number\": The account number embossed onto the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 9, maximum length 19).\n\"*expiry\": Expiry date, as shown on the card.\n\"*month\": Month, as shown on the card. Months are numbered January=1, through to December=12.(Validation Rules: Data is a number between 1 and 12 represented as a string. JSON type String).\n\"*year\": Year, as shown on the card. The Common Era year is 2000 plus this value.(Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 2, maximum length 2).\n\"securityCode\": Card verification code, as printed on the back or front of the card. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 3, maximum length 4).\n\"*type\": The payment method used for this payment. (Validation Rules: JSON type String, \"CARD\").\n\"*transaction\": Information about this transaction.\n\"*source\": Indicates the source through which you received the transaction. (Validation Rules: JSON type String, \"INTERNET\").\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40.\n\"*correlationId\": A transient identifier for the request, that can be used to match the response to the request. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.identifier\": A identifier for the FLW sub-merchant. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.address.company\": The name of the company associated with this address. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.address.country\": The 3 letter ISO standard alpha country code of the address. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.address.city\": The city portion of the address. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.address.street\": The first line of the address. For example, this may be the street name and number, or the Post Office Box details. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.address.street2\": The second line of the address (if provided). (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.registeredName\": The name of the company associated with this address. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 100)\n\"*subMerchant.tradingName\": The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as. The name must not exceed 21 characters (including payfac name which is 4 characters and set on MPGS). Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 17)\n\"*subMerchant.bankIndustryCode\": Code used by acquirer to describe the business or industry the sub-merchant operates in. (Validation Rules: Data is a string that consists of the characters 0-9. JSON type String, minimum length 4, maximum length 4)\n\n{\n \"apiOperation\": \"PAY\",\n \"correlationId\": \"TESTCARD06\"\n \"order\": {\n \"amount\": \"1.00\",\n \"currency\": \"EGP\",\n \"reference\": \"OPT-REF01\"\n },\n \"sourceOfFunds\": {\n \"provided\": {\n \"card\": {\n \"number\": \"597823xxxxxx7867\",\n \"expiry\": {\n \"month\": \"01\",\n \"year\": \"29\"\n },\n \"securityCode\": \"100\"\n }\n },\n \"type\": \"CARD\"\n },\n \"transaction\": {\n \" source\": \"INTERNET\",\n \"reference\": \"PTVe-REF01\"\n }\n}\n\nA card capture is a binding step that takes place after a payment authorization that officially moves a customer's funds into your account.
\nIn other words, it's the moment when a pending payment becomes a completed payment.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n*{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n\nBody Parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"CAPTURE\").\n\n\"*order\": Information about the order associated with this transaction.\n\n\"*reference\": The identifier of the order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\n\"*transaction\": Information about this transaction.\n\n\"*amount\": The total amount for the transaction. (Validation Rules: Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number. JSON type String, minimum length 1, maximum length 14).\n\n\"*currency\": The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 3, maximum length 3).\n\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40.\n\n{\n \"apiOperation\": \"CAPTURE\",\n \"order\": {\n \"reference\": \"OPT-REF01\"\n },\n \"transaction\": {\n \"amount\": \"1.00\",\n \"currency\": \"EGP\",\n \"reference\": \"PTC-REF01\"\n }\n}\n\nThis allows the merchant reverse a previously captured payment.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n*{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\nBody Parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"REFUND\").\n\n\"*order\": Information about the order associated with this transaction.\n\n\"*reference\": The identifier of the order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\n\"*transaction\": Information about this transaction.\n\n\"*amount\": The total amount for the transaction. (Validation Rules: Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number. JSON type String, minimum length 1, maximum length 14)\n\n\"*currency\": The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD. (Validation Rules: Data must consist of the characters A-Z. JSON type String, minimum length 3, maximum length 3).\n\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40.\n\n{\n \"apiOperation\": \"REFUND\",\n \"order\": {\n \"reference\": \"OPT-REF01\"\n },\n \"transaction\": {\n \"amount\": \"1.00\",\n \"currency\": \"EGP\",\n \"reference\": \"PTC-REF01\"\n }\n}\n\nWhen your customer decides not to complete their purchase or where you are unable to fulfill an order you can quickly release the funds you authorized on your customer's card by voiding the authorization using the void command.
\nField properties with * are required.
\nHTTP Method: PUT
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n*{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n\nBody Parameters
\n\"*apiOperation\": the API operation done on the customer's card. (Validation Rules: Data type: string \"VOID\").\n\n\"*transaction\": Information about this transaction.\n\n\"*targetTransactionId\": The identifier for the transaction you wish to void. That is the transaction.reference field on authorization request. (Validation Rules: JSON type String, minimum length 1, maximum length 40).\n\n\"*reference\": The identifier of the transaction, to distinguish it from all transactions you ever issue on any order. (Validation Rules: Data can consist of any characters. JSON type String, minimum length 1, maximum length 40).\n\n{\n \"apiOperation\": \"VOID\",\n \"transaction\": {\n \"targetTransactionId\": \"PT-REF01\",\n \"reference\": \"PTV-REF01\"\n }\n}\n\nRequest to retrieve the details of a transaction. For example you can retrieve the details of an authorization/capture/refund/void that you previously executed.
\nField properties with * are required.
\nHTTP Method: GET
\nURL Parameters
\n*{merchantId}: The unique identifier issued to you by your payment provider. (Validation Rules: Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.' XSD type string, minimum length 1, maximum length 40).\n\n*{orderid}: A unique identifier for this order to distinguish it from any other order you create. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n{transactionid}: Unique identifier for this transaction to distinguish it from any other transaction on the order. Each transaction on the order must have a unique id that identifies that transaction. Some transactions also hold the transaction identifier of other transactions on the order. For example a void payment transaction references the original payment transaction that is being voided. If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry. (Validation Rules: Data may consist of any characters. XSD type string, minimum length 1, maximum length 40).\n\n\n