CyberSource void API

openapi: 3.2.0
info:
  description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
  version: 0.0.1
  title: CyberSource Merged Spec bankAccountValidation Void API
servers:
- url: https://apitest.cybersource.com/
tags:
- name: void
  description: 'A void cancels a payment or capture. A transaction can be voided only when CyberSource has not already

    submitted the capture to your processor. You cannot undo a void.

    '
paths:
  /pts/v2/payments/{id}/voids:
    post:
      summary: Void a Payment
      description: 'Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to cancel the payment.

        '
      tags:
      - void
      operationId: voidPayment
      x-devcenter-metaData:
        categoryTag: Payments
        developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html
        isMLEsupported: true
        mleForRequest: optional
      parameters:
      - name: id
        in: path
        description: The payment ID returned from a previous payment request.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/hal+json;charset=utf-8:
              schema:
                title: ptsV2PaymentsVoidsPost201Response
                type: object
                properties:
                  _links:
                    type: object
                    properties:
                      self:
                        type: object
                        properties:
                          href:
                            type: string
                            description: This is the endpoint of the resource that was created by the successful request.
                          method:
                            type: string
                            description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.'
                  id:
                    type: string
                    maxLength: 26
                    description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services.

                      It is also appended to the endpoint of the resource.

                      On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.

                      '
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`

                      **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).

                      The `T` separates the date and the time. The `Z` indicates UTC.


                      Returned by Cybersource for all services.

                      '
                  status:
                    type: string
                    description: "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n - CANCELLED\n - FAILED\n"
                  clientReferenceInformation:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 59
                        description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each

                          transaction so that you can perform meaningful searches for the transaction.


                          #### Used by

                          **Authorization**

                          Required field.


                          #### PIN Debit

                          Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being

                          reversed.


                          Required field for all PIN Debit requests (purchase, credit, and reversal).


                          #### FDC Nashville Global

                          Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.

                          '
                      submitLocalDateTime:
                        type: string
                        maxLength: 14
                        description: 'Date and time at your physical location.


                          Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds


                          #### PIN Debit

                          Optional field for PIN Debit purchase and credit requests.

                          '
                      ownerMerchantId:
                        type: string
                        description: 'Merchant ID that was used to create the subscription or customer profile for which the service was requested.


                          If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using

                          subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.


                          If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using

                          profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.

                          '
                  voidAmountDetails:
                    type: object
                    properties:
                      voidAmount:
                        type: string
                        description: 'Total amount of the void.


                          #### PIN Debit

                          Amount of the reversal.


                          Returned by PIN debit reversal.

                          '
                      originalTransactionAmount:
                        type: string
                        description: Amount of the original transaction.
                      currency:
                        type: string
                        maxLength: 3
                        description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)


                          #### Used by

                          **Authorization**

                          Required field.


                          **Authorization Reversal**

                          For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.


                          #### PIN Debit

                          Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).

                          Returned by PIN debit purchase.


                          For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.

                          For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).


                          Required field for PIN Debit purchase and PIN Debit credit requests.

                          Optional field for PIN Debit reversal requests.


                          #### GPX

                          This field is optional for reversing an authorization or credit.


                          #### DCC for First Data

                          Your local currency.


                          #### Tax Calculation

                          Required for international tax and value added tax only.

                          Optional for U.S. and Canadian taxes.

                          Your local currency.

                          '
                  processorInformation:
                    type: object
                    properties:
                      responseCode:
                        type: string
                        maxLength: 10
                        description: 'For most processors, this is the error message sent directly from the bank. Returned only when the processor

                          returns this value.


                          **Important** Do not use this field to evaluate the result of the authorization.


                          #### PIN debit

                          Response value that is returned by the processor or bank.

                          **Important** Do not use this field to evaluate the results of the transaction request.


                          Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.


                          #### AIBMS

                          If this value is `08`, you can accept the transaction if the customer provides you with identification.


                          #### Atos

                          This value is the response code sent from Atos and it might also include the response code from the bank.

                          Format: `aa,bb` with the two values separated by a comma and where:

                          - `aa` is the two-digit error message from Atos.

                          - `bb` is the optional two-digit error message from the bank.


                          #### Comercio Latino

                          This value is the status code and the error or response code received from the processor separated by a colon.

                          Format: [status code]:E[error code] or [status code]:R[response code]

                          Example `2:R06`


                          #### JCN Gateway

                          Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field.

                          String (3)


                          #### paypalgateway

                          Processor generated ID for the itemized detail.

                          '
                      responseDetails:
                        type: string
                        maxLength: 60
                        description: 'The reason for when the transaction status is Pending or Reversed.

                          Possible values:

                          - `PAYER_SHIPPING_UNCONFIRMED`

                          - `MULTI_CURRENCY`

                          - `RISK_REVIEW`

                          - `REGULATORY_REVIEW`

                          - `VERIFICATION_REQUIRED`

                          - `ORDER`

                          - `OTHER`

                          '
                      transactionId:
                        type: string
                        maxLength: 255
                        description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are

                          discussing the transaction with your processor. Not all processors provide this value.


                          Returned by the authorization service.


                          #### PIN debit

                          Transaction identifier generated by the processor.


                          Returned by PIN debit credit.


                          #### GPX

                          Processor transaction ID.


                          #### Cielo

                          For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.


                          #### Comercio Latino

                          For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.


                          #### CyberSource through VisaNet and GPN

                          For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)


                          #### Moneris

                          This value identifies the transaction on a host system. It contains the following information:

                          - Terminal used to process the transaction

                          - Shift during which the transaction took place

                          - Batch number

                          - Transaction number within the batch

                          You must store this value. If you give the customer a receipt, display this value on the receipt.


                          **Example** For the value

                          66012345001069003:

                          - Terminal ID = 66012345

                          - Shift number = 001

                          - Batch number = 069

                          - Transaction number = 003

                          '
                  reconciliationId:
                    type: string
                    maxLength: 60
                    description: 'Reference number that you use to reconcile CyberSource reports with your reports.

                      '
                example:
                  _links:
                    self:
                      href: /pts/v2/voids/4963015122056179201545
                      method: GET
                  id: '4963015122056179201545'
                  submitTimeUtc: 2017-06-01T071832Z
                  status: VOIDED
                  clientReferenceInformation:
                    transactionId: '909080801'
                  orderInformation:
                    amountDetails:
                      currency: USD
                  voidAmountDetails:
                    currency: usd
                    voidAmount: '102.21'
        '400':
          description: Invalid request.
          content:
            application/hal+json;charset=utf-8:
              schema:
                title: ptsV2PaymentsVoidsPost400Response
                type: object
                properties:
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`

                      **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).

                      The `T` separates the date and the time. The `Z` indicates UTC.


                      Returned by Cybersource for all services.

                      '
                  status:
                    type: string
                    description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n"
                  reason:
                    type: string
                    description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n - NOT_SUPPORTED\n"
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: This is the flattened JSON object field name/path that is either missing or invalid.
                        reason:
                          type: string
                          description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n"
        '502':
          description: Unexpected system error or system timeout.
          content:
            application/hal+json;charset=utf-8:
              schema:
                title: ptsV2PaymentsVoidsPost502Response
                type: object
                properties:
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`

                      **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).

                      The `T` separates the date and the time. The `Z` indicates UTC.


                      Returned by Cybersource for all services.

                      '
                  status:
                    type: string
                    description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n"
                  reason:
                    type: string
                    description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n"
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
      x-example:
        example0:
          summary: Void a Payment
          value:
            clientReferenceInformation:
              code: test_void
          depends:
            example:
              path: /pts/v2/payments
              verb: post
              exampleId: example0
            fieldMapping:
            - sourceField: id
              destinationField: id
              fieldTypeInDestination: path
        example1:
          summary: Pin Debit Purchase Reversal - Void
          value:
            clientReferenceInformation:
              code: Pin Debit Purchase Reversal(Void)
            orderInformation:
              amountDetails:
                totalAmount: '202.00'
                currency: USD
            paymentInformation:
              paymentType:
                name: CARD
                subTypeName: DEBIT
          depends:
            example:
              path: /pts/v2/payments
              verb: post
              exampleId: example1
            fieldMapping:
            - sourceField: id
              destinationField: id
              fieldTypeInDestination: path
        example2:
          summary: EBT - Reversal of Purchase from SNAP Account
          value:
            clientReferenceInformation:
              code: Reversal of Purchase from SNAP Account
            orderInformation:
              amountDetails:
                totalAmount: '101.00'
                currency: USD
            paymentInformation:
              card:
                type: '001'
              paymentType:
                name: CARD
                subTypeName: DEBIT
          depends:
            example:
              path: /pts/v2/payments
              verb: post
              exampleId: example2
            fieldMapping:
            - sourceField: id
              destinationField: id
              fieldTypeInDestination: path
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              type: object
              properties:
                clientReferenceInformation:
                  type: object
                  properties:
                    code:
                      type: string
                      maxLength: 59
                      description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each

                        transaction so that you can perform meaningful searches for the transaction.


                        #### Used by

                        **Authorization**

                        Required field.


                        #### PIN Debit

                        Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being

                        reversed.


                        Required field for all PIN Debit requests (purchase, credit, and reversal).


                        #### FDC Nashville Global

                        Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.

                        '
                    pausedRequestId:
                      type: string
                      maxLength: 26
                      description: 'Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call.

                        '
                    comments:
                      type: string
                      description: Brief description of the order or any comment you wish to add to the order.
                    partner:
                      type: object
                      properties:
                        developerId:
                          type: string
                          maxLength: 8
                          description: 'Identifier for the developer that helped integrate a partner solution to CyberSource.


                            Send this value in all requests that are sent through the partner solutions built by that developer.

                            CyberSource assigns the ID to the developer.


                            **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.

                            '
                        solutionId:
                          type: string
                          maxLength: 8
                          description: 'Identifier for the partner that is integrated to CyberSource.


                            Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.


                            **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.

                            '
                        thirdPartyCertificationNumber:
                          type: string
                          maxLength: 12
                          description: 'Value that identifies the application vendor and application version for a third party gateway.

                            CyberSource provides you with this value during testing and validation.

                            This field is supported only on CyberSource through VisaNet.


                            #### Used by

                            **Authorization, Authorization Reversal, Capture, Credit, Incremental Authorization, and Void**

                            Optional field.


                            #### PIN debit

                            Required field for PIN debit credit, PIN debit purchase, or PIN debit reversal request.

                            '
                    applicationName:
                      type: string
                      description: 'The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.

                        '
                    applicationVersion:
                      type: string
                      description: 'Version of the CyberSource application or integration used for a transaction.

                        '
                    applicationUser:
                      type: string
                      description: 'The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.

                        '
                    reconciliationId:
                      type: string
                      maxLength: 60
                      description: 'Reference number for the transaction.

                        Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource.

                        The actual value used in the request to the processor is provided back to you by Cybersource in the response.

                        '
                    transactionId:
                      type: string
                      maxLength: 30
                      description: 'Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request.


                        **Note** Use this field only if you want to support merchant-initiated reversal and void operations.


                        #### Used by

                        **Authorization, Authorization Reversal, Capture, Credit, and Void**

                        Optional field.


                        #### PIN Debit

                        For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier.

                        Optional field for PIN debit purchase or credit requests.

                        '
                paymentInformation:
                  type: object
                  properties:
                    paymentType:
                      type: object
                      properties:
                        name:
                          type: string
                          description: 'A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.

                            Possible values:

                            - `CARD` (use this for a PIN debit transaction)

                            - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)

                            - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP)

                            - `localCard` (KCP Local card via Altpay)

                            - `carrierBilling` (KCP Carrier Billing via Altpay)

                            '
                        subTypeName:
                          type: string
                          description: 'In case the APM supports multiple modes of initiation (e.g. Alipay via QR Code or Barcode)

                            '
                        method:
                          type: object
                          properties:
                            name:
                              type: string
                              description: 'A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, bofaPayByBank, payToPayByBank, etc


                                For Japan Payment Processing Valid Values:

                                - 1 Banking Data

                                - 2 Authorization Data


                                #### Via KCP

                                - `KCP` : Local Card, Bank Transfer and Carrier Billing.

                                - `PAYCO`

                                - `KAKAOPAY`

                                - `NAVERPAY`

                                '
                orderInformation:
                  type: object
                  properties:
                    amountDetails:
                      type: object
                      properties:
                        totalAmount:
                          type: string
                          maxLength: 19
                          description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n"
                        currency:
                          type: string
                          maxLength: 3
                          description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)


                            #### Used by

                            **Authorization**

                            Required field.


                            **Authorization Reversal**

                            For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.


                            #### PIN Debit

                            Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).

                            Returned by PIN debit purchase.


                            For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.

                            For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).


                            Required field for PIN Debit purchase and PIN Debit credit requests.

                            Optional field for PIN Debit reversal requests.


                            #### GPX

                            This field is optional for reversing an authorization or credit.


                            #### DCC for First Data

                            Your local currency.


                            #### Tax Calculation

                            Required for international tax and value added tax only.

                            Optional for U.S. and Canadian taxes.

                            Your local currency.

                            '
                agreementInformation:
                  type: object
                  properties:
                    agreementId:
                      type: string
                      m

# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cybersource/refs/heads/main/openapi/cybersource-void-api-openapi.yml