Skip to main content

Void Request

POST 
/EPGCheckout/rest/online/void - Void Request
H2H Void Request

Query Parameters

  • merchantId string required

    Identifier of your business in the Addon Payments platform.

    Example: 123456
  • encrypted string required
    • Encryption of the clear query parameters
    • And the final data sent will be in base64 form
    • For the object see the Request Body
    Example: yGbFUz+X9hDK/R39QFRpckGojl/vSCJPCETpxxwPTXw+q+NQMeHUQDbj7OJYy6ZsKE+sbQIedQ36YUc8yKt7/aOU5xyyFamFaUM5MzU4oOAPNwBEkeBrbGdb0uwyJEJObij0tao1+r5XSCLBKGd1FM8pAhROaGJ8SqdFFWlgx2x9zvhtARDdU79AUPK79uAu9h34PK8eJCpPzLD2jRX7EruCtHeDjuPPZWUo2yhAMO33cKmTv8pGOGnFr0U+KbacbZZMZk2l0X+KADpKOLVFMvLJAOKR7kpqNXcqQulgaU8VtlXizk4bj6Gc/EilVcfyb7Ibyb9AO2hO3VvUk6/b9yCzIE4kIaKnKTmi5QuBKbR9zPDnPgjstMNZgpa9iY5XWxPR+FQA3DGgprnMUxwB6b6y5YQz7Z3Y4TBsjDTSb/2kl/pGBwx0C8kFleLcBZQbr7dgLO3OxAO+RnMOrU4SdTjKTJ9XcWeLsVlw0Ti7a625lpsFTej/q279KyEcoPmJaQnraXbm+ERM8hz5nPeQzvmmyXSnNB5noWbhAQGOnZVqopor9c14rH1NCasAyqgq7auzk39WdVlVCXKvQ01MIerjfr7jQhKHrnQ9Nz/T0hpbxMGxxsMLzjIe5xAz8VfCfwUaS96wQLqU+NCV9PBY79fH55rUPChEFZaQoFzOema6UEC+qvYScceiGtU15Abr+yjGCnAvHjpbdJykwTgEcWcNjOvntuLrpkTrnc/4L5VYyqvW2SUfQ7UKpfuEIoy4KU54dih1jM3MCIhh/vGrqBUsi2mmJUxrkkREkKrCR36CI6I0zv/sp2l7htzB3f8v1wq6rMCyo6a2yLSpHXSdk9jcEkwUbfEhb5SAsbTIw/Hpumr8POkXHiENx9ntg7htB8j4ON7ubnG5Qb93ktWI8uPuSQDf/+rCMii33YI2yjS59w/z5I40FG40lVDwgU0H1xSFiLbICFda78oQCOXHiFcTLlL7joV1JTHiwBYa5gz2Cwkm6toLZkVLW6O6ZmFtMMu++VjIcyeJaA+IssCpptSQq5mtq/tzLb2UzER0xSGRLzX0lVIi21P31KaVws4dX1rrx3McAoJArsrITamPI8kN+hzmgaErpQfwH994ivNBT/1jUlOvs6CXvEawU5vrCegp1ayofYeeyIo7JIvbjPfI6C58KJMxwHr+IWbTOFY+GErQxo3k5UTBmSICmkekzcgToaxzKYS6v/55VPJpNCl5lBNLoyj6u67jsQooYgkInnaYBidEW8Tc/mryz07P
  • integrityCheck string required
    • Hash256 of the clear query parameters in UTF_8 bytes
    • Sent in hex form in lower case
    Example: c4ca128afe39a4e2c5c3c529813f536d0265b5b90f30eeb3278236406d67db7c

Header Parameters

  • apiVersion string required

    Version of the AP API for which the request should be processed

    • Supported values are 3, 4, and 5 (recommended)
    Example: 5
  • encryptionMode string required

    AES-256 encryption type used (CBC)

    Example: CBC
  • iv string required

    Initial Vector used in the encryption process in Base64 Form

    Example: gH9j/x+Qu7M2r2SYPfa3UA==

Body

-- DON'T SEND THIS REQUEST BODY, IT'S JUST FOR DESCRIPTION -- This is the object used in "encrypted" field
    merchantId Integer numeric 4~7 digitsrequired

    Identifier of your business on the AP platform.

    • It is a numeric code provided by Support in the welcome email
    • It has 4 to 7 digits and is common for both environments (test/production).
    merchantTransactionId Alphanumeric Max. 45 charactersrequired

    Transaction identifier in your trading platform electronic. It is used for your platform to link the notifications received with the customer's order.

    • It cannot be repeated between transactions.
    • Max. 45 characters - Latin-1 code page (ISO-8859-1)
    paymentSolution stringrequired

    Name of the payment solution through which the transaction must be processed (caixapucpuce , etc.).

    transactionId Integer numeric Max. 100 digitsrequired

    id. of the initial transaction in AP on which a secondary transaction is going to be carried out (settlement, release, return). It is required only in secondary transactions that are made on top of an authorized initial transaction.

    description Max 1000 characters

    Description of the transaction. Saved in the transaction details and returned in the notification. Doesn’t affect the transaction. Helps you identify it more easily.

Responses
Redirect Link Created With Loading Screen
Schema
    string
Loading...