DIdintero
Transactions

transactions_id_void_post

At any moment before capture of a transaction, it is possible to cancel an authorization. This operation is called voiding and can be performed by doing a POST to this endpoint

Void on part capture

Void after a part capture will cancel the difference between the capture amount and the authorization amount.

Void on part capture is only supported on following types:

  • payex.creditcard
  • payex.mobilepay
  • payex.vipps
  • payex.applepay
  • payex.clicktopay
  • payex.googlepay
  • vipps
  • klarna.klarna
  • klarna.billie

scopes:

  • admin:checkout
  • write:checkout
post/accounts/{aid}/payments/transactions/{id}/void

Request

Path parameters

idstring checkout-id required

The ID of the transaction

Query parameters

includesstring[]

Include aditional data in the returned data that are by default excluded from the transaction details.

  • events.request_headers Include the event headers stored for each event deprecated
  • initiating_system_request_headers Include the request headers from the initating system deprecated

From 2023-09, events.request_headers and initiating_system_request_headers will be included by default

Headers

Dintero-System-Namestring

The name of the ecommerce solution

Example: woocommerce

Dintero-System-Versionstring

The version number of the ecommerce solution

Example: 5.4

Dintero-System-Plugin-Namestring

The name of the ecommerce plugin

Example: Dintero.Checkout.WooCommerce

Dintero-System-Plugin-Versionstring

The version number of the ecommerce plugin

Example: 2.3.4

Response

Transaction voided

idstring

An ID that uniquely identifies the resource

created_atstring date-time

When the transaction was created

payment_product'bambora' | 'collector' | 'dintero' | 'dintero_psp' | 'instabank' | 'klarna' | 'netaxept' | 'payex' | 'santander' | 'swish' | 'vipps' | 'kravia' | 'two' | 'seitatech' required

The payment product corresponding to this transaction

payment_product_type'bambora.applepay' | 'bambora.creditcard' | 'bambora.googlepay' | 'bambora.mobilepay' | 'bambora.vipps' | 'collector.invoice' | 'collector.invoice_b2b' | 'collector.invoice_b2b_preapproved' | 'collector.installment' | 'dintero.zero' | 'dintero.wallets' | 'dintero.external' | 'dintero_psp.creditcard' | 'dintero_psp.vipps' | 'dintero_psp.googlepay' | 'dintero_psp.applepay' | 'dintero_psp.clicktopay' | 'instabank.finance' | 'instabank.invoice' | 'instabank.installment' | 'instabank.postponement' | 'klarna.klarna' | 'klarna.billie' | 'kravia.invoice_b2b' | 'kravia.invoice_b2b_grouped' | 'kravia.invoice_b2c' | 'two.invoice_b2b' | 'netaxept.creditcard' | 'payex.creditcard' | 'payex.mobilepay' | 'payex.swish' | 'payex.vipps' | 'payex.applepay' | 'payex.clicktopay' | 'payex.googlepay' | 'santander.debit_account' | 'seitatech.in_person' | 'swish.swish' | 'vipps' required

The payment product type corresponding to this transaction

amountinteger required

Non-negative, minor units. Total amount of the transaction

currencystring iso4217-code required

ISO 4217 transaction currency

payout_destination_idstring

An id that identifies the seller, value will be included in the settlement reports

merchant_referencestring

A reference specified by the merchant to identify the transaction

channel'ecommerce' | 'in_app' | 'in_store'

The channel for the transaction

platform_type'aggregator' | 'marketplace'

Type of platform the merchant is.

merchant_reference_2string

A reference specified by the merchant to identify the transaction, can be updated after the transaction has been created

dynamic_descriptorstring

A short reference / descriptor that will show up on the customers bank statement

payment_operation'unscheduled_purchase' | 'recurring_purchase' | 'generate_payment_token'

Initiated by the merchant or used to generate a token

settlement_status'NOT_SETTLED' | 'PENDING_SETTLEMENT' | 'PARTIALLY_SETTLED' | 'SETTLED'

Overall settlement status after the events

customer_ipstring

The IP address of the customer

user_agentstring

The full user agent string of the device the customer used to submit the transaction

status'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CAPTURED' | 'PARTIALLY_CAPTURED' | 'PARTIALLY_CAPTURED_REFUNDED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'DECLINED' | 'FAILED' | 'UNKNOWN' | 'ON_HOLD'

The current status of the transaction

session_idstring

The session id for the transaction

updated_atstring date-time

When the transaction was last modified.

Changes

No recorded changes to this operation across all 1 revision of this API.