Confirm transaction

Use this request to confirm a transaction.

To confirm a transaction, use a POST method and the following URL:

https://{service_url}/api/v2/transactions/{key}/confirm

where:

  • {service_url} is the URL of the service's environment.
  • {key} is the Transaction Key. This key is generated when the Store transaction request is sent.

Details

TypeValue
Endpoint/api/v2/transactions/:key/confirm
MethodPOST
API ReferenceConfirm transaction

Body Parameters

ParameterDescription
private_tokenPrivate token.
keyThe Transaction Key that is generated by the Store transaction request.
TransactionAny transaction details that you wish to include. See Transaction Schema.

Response Example

The following is an example of a successful response:

{
   "transaction" : {
      "custom_fields" : null,
      "tax_entity_name" : "Ireland",
      "tax_deducted" : true,
      "tax_required_fields" : [],
      "additional_currencies" : {},
      "tax_supported" : true,
      "refunded_total_amount" : 0,
      "update_timestamp" : 1477302544578,
      "invoice_date" : "2014-11-15T00:00:00Z",
      "tax_timezone" : "GB",
      "custom_id" : "custom_id_121441",
      "buyer_tax_number" : "IE5251981413X",
      "amount" : 100,
      "invoice_address" : {
         "street_name" : "Langford St",
         "building_number" : "31",
         "city" : "Killorglin",
         "region" : "Kerry"
      },
      "status" : "C",
      "buyer_ip" : "127.0.0.1",
      "invoice_number" : "511414/2013",
      "create_timestamp" : "2016-10-24T09:46:22Z",
      "transaction_lines" : [
         {
            "product_type" : "e-service",
            "total_amount" : 100,
            "quantity" : 1,
            "unit_price" : 100,
            "tax_rate" : 0,
            "tax_amount" : 0,
            "amount" : 100,
            "line_key" : "1atQhzXRqCJ3ELhM",
            "custom_id" : "line1",
            "description" : "hosting",
            "product_code" : "hosting_1",
            "tax_name" : "European VAT",
            "deducted_tax_amount" : 0,
            "line_num" : 1
         }
      ],
      "currency_code" : "EUR",
      "total_amount" : 100,
      "tax_region" : "EU",
      "test" : true,
      "deducted_tax_amount" : 0,
      "invoice_place" : "Geneva, Switzerland",
      "tax_number_service" : "vies",
      "storage_required_fields" : [],
      "refunded_tax_amount" : 0,
      "tax_amount" : 0,
      "buyer_credit_card_prefix" : "424242424",
      "evidence" : {
         "by_billing" : {
            "evidence_type" : "by-billing",
            "used" : null,
            "resolved_country_code" : null,
            "evidence_value" : "IE"
         },
         "by_ip" : {
            "evidence_value" : "127.0.0.1",
            "resolved_country_code" : null,
            "used" : null,
            "evidence_type" : "by-ip"
         },
         "forced" : {
            "evidence_value" : null,
            "evidence_type" : "forced",
            "resolved_country_code" : null,
            "used" : null
         },
         "by_tax_number" : {
            "resolved_country_code" : null,
            "used" : null,
            "evidence_type" : "by-tax-number",
            "evidence_value" : "IE5251981413X"
         },
         "by_cc" : {
            "evidence_type" : "by-cc",
            "used" : null,
            "resolved_country_code" : null,
            "evidence_value" : "424242424"
         },
         "by_token" : {
            "evidence_value" : null,
            "resolved_country_code" : null,
            "used" : null,
            "evidence_type" : "by-token"
         }
      },
      "kind" : "eu-b2b",
      "fully_informative" : false,
      "order_date" : "2013-11-14T00:00:00Z",
      "tax_country_code" : "IE",
      "confirm_timestamp" : "2016-10-24T09:51:36Z",
      "key" : "TvNYAAAABSFKsHx6-KjhYDdhu0hQ",
      "billing_country_code" : "IE"
   }
}