Skip to main content

Cancel payment

DELETE 
/v1/payment-service/payment-product/paymentId

Description​

Cancel a payment transaction.

tip

Stop a payment process and handle any necessary follow-up actions.

Request​

Path Parameters

    payment-service stringrequired

    The payment service that is used to initiate the payment.
    Available options: payments.

    payment-product stringrequired

    The addressed payment product endpoint, e.g., for SEPA Credit Transfers (SCT).
    Available options: internal-transfers, sepa-credit-transfers.

    paymentId stringrequired

    The unique ID of the payment to be cancelled.

Header Parameters

    X-Request-ID uuidrequired

    ID of the request, unique to the call, as determined by the initiating party.

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    Ocp-Apim-Subscription-Key stringrequired

    A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses​

Received
Schema
    transactionStatus int32

    The status of the transaction after the cancellation request.
    Available options: 0-13.

    scaMethods object[]A list of Strong Customer Authentication (SCA) methods available in order to authenticate the cancellation request.
  • Array [
    • authenticationType int32

    The type of authentication used, such as SMS OTP or push notification.
    Available options: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe version of the authentication method being implemented.
    authenticationMethodId stringThe ID of the authentication method.
    name stringA human-readable name for the authentication method.
    explanation stringA brief explanation or description of the authentication method.
  • ]
    • chosenScaMethod objectThe selected Strong Customer Authentication (SCA) method to authenticate the cancellation.
    authenticationType int32

    The type of the authentication method.
    Available options: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe version of the authentication method.
    authenticationMethodId string
    name stringA human-readable name for the authentication method.
    explanation stringA brief explanation or description of the authentication method.
    challengeData object
    image byteAn image associated with the payment.
    data string[]Data related to the payment.
    imageLink stringA link to an image associated with the payment.
    otpMaxLength int32The maximum length of the OTP for authentication.
    otpFormat int32

    The format of the OTP (One-Time Password) used for authentication.
    Available options: 0 = "CHARACTERS", 1 = "INTEGER".

    additionalInformation stringExtra details or supplementary information about the payment.
    links objectA collection of hyperlinks related to the cancellation. This includes links to related resources or actions that can be taken following the cancellation request.
Loading...