v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

3D Secure Pre-Authentication

Create a 3D secure pre-authentication to be used in the client SDK 3DS canvas

post/v1/charges/3ds

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Request body

amountstring required

The amount of the transaction

currencystring required

The currency of the transaction. Available: 'AUD'

Response

200

statusinteger

{"stackTrail":"paths:/v1/charges/3ds:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 201,
  "resource": {
    "type": "charge",
    "data": {
      "statistics": {
        "need_sync": true
      },
      "customer": {
        "payment_source": {
          "card_number_last4": "0008",
          "card_number_bin": "51234500",
          "card_scheme": "mastercard",
          "expire_month": 1,
          "expire_year": 2039,
          "gateway_id": "GATEWAY_ID",
          "gateway_type": "MasterCard",
          "gateway_name": "MasterCard",
          "type": "card",
          "vault_token": "VAULT_TOKEN",
          "card_number_hash_uuid": "a82b8a86-3d9f-43d5-8034-8f62f678cea6"
        }
      },
      "_3ds": {
        "id": "e139a49a-0858-4af8-a6ae-d4f94c2c992c",
        "token": "eyJjb250ZW50IjoiPGRpdiBpZD1cInRocmVlZHNDaGFsbGVuZ2VSZWRpcmVjdFwiIHhtbG5zPVwiaHR0cDovL3d3dy53My5vcmcvMTk5OS9odG1sXCIgc3R5bGU9XCIgaGVpZ2h0OiAxMDB2aFwiPiA8Zm9ybSBpZCA9XCJ0aHJlZWRzQ2hhbGxlbmdlUmVkaXJlY3RGb3JtXCIgbWV0aG9kPVwiUE9TVFwiIGFjdGlvbj1cImh0dHBzOi8vbXRmLmdhdGV3YXkubWFzdGVyY2FyZC5jb20vYWNzL21hc3RlcmNhcmQvdjIvcHJvbXB0XCIgdGFyZ2V0PVwiY2hhbGxlbmdlRnJhbWVcIj4gPGlucHV0IHR5cGU9XCJoaWRkZW5cIiBuYW1lPVwiY3JlcVwiIHZhbHVlPVwiZXlKMGFISmxaVVJUVTJWeWRtVnlWSEpoYm5OSlJDSTZJakl4TW1JNU1ERTFMV1V3Tm1VdE5EQTRPUzA0WkRBNExXVmpNMk0wTnpGa1pXTTVZeUo5XCIgLz4gPC9mb3JtPiA8aWZyYW1lIGlkPVwiY2hhbGxlbmdlRnJhbWVcIiBuYW1lPVwiY2hhbGxlbmdlRnJhbWVcIiB3aWR0aD1cIjEwMCVcIiBoZWlnaHQ9XCIxMDAlXCIgPjwvaWZyYW1lPiA8c2NyaXB0IGlkPVwiYXV0aGVudGljYXRlLXBheWVyLXNjcmlwdFwiPiB2YXIgZT1kb2N1bWVudC5nZXRFbGVtZW50QnlJZChcInRocmVlZHNDaGFsbGVuZ2VSZWRpcmVjdEZvcm1cIik7IGlmIChlKSB7IGUuc3VibWl0KCk7IGlmIChlLnBhcmVudE5vZGUgIT09IG51bGwpIHsgZS5wYXJlbnROb2RlLnJlbW92ZUNoaWxkKGUpOyB9IH0gPC9zY3JpcHQ+IDwvZGl2PiIsImZvcm1hdCI6Imh0bWwiLCJjaGFyZ2VfM2RzX2lkIjoiZTEzOWE0OWEtMDg1OC00YWY4LWE2YWUtZDRmOTRjMmM5OTJjIn0="
      },
      "status": "pre_authentication_pending",
      "type": "financial",
      "capture": true,
      "one_off": true,
      "_source_ip_address": "10.0.0.0",
      "_id": "65b993ce02f40c0ef72d4e54",
      "amount": 100,
      "currency": "AUD",
      "company_id": "649a6edfb848941bea648bd6",
      "transactions": [
        {
          "_3ds": {
            "gateway_status": "AUTHENTICATION_PENDING",
            "challenge": true
          },
          "_id": "65b993ce02f40c0ef72d4e57",
          "status": "complete",
          "type": "3ds",
          "amount": 100,
          "currency": "AUD",
          "created_at": "2024-01-31T00:26:54.836Z",
          "updated_at": "2024-01-31T00:26:57.340Z",
          "processed_at": "2024-01-31T00:26:57.340Z"
        }
      ],
      "created_at": "2024-01-31T00:26:54.806Z",
      "updated_at": "2024-01-31T00:26:57.360Z",
      "__v": 1,
      "external_id": "13ba6ca9-bb2d-430c-b27a-111407e1c44a:6344246d-cd3f-461e-9c16-934524d22ccf"
    }
  }
}