v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Verification

Validate a customer's card prior to submitting a financial transaction to the gateway.

post/v1/charges/verification

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

The amount of the transaction

currencystring required

The iso4217 alpha-3 currency code. Allowed: 'AUD'

referencestring

The manually defined reference of the verification request.

initialization_sourcestring

The mechanism the cardholder used to accept the transaction, i.e. internet

order_idstring

A unique value generated by the merchant to identify a order.

transaction_idstring

A unique value generated by the merchant to identify a transaction.

Response

200

statusinteger

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

Example response

{
  "status": 201,
  "resource": {
    "type": "charge",
    "data": {
      "_id": "63fd288edc1a690652970f49",
      "currency": "AUD",
      "company_id": "5adacf0c30efdb1c6d055ae5",
      "type": "verification",
      "status": "complete",
      "external_id": "923114960953-738613",
      "created_at": "2023-02-27T22:02:54.882Z",
      "updated_at": "2023-02-27T22:02:55.298Z",
      "customer": {
        "payment_source": {
          "type": "card",
          "gateway_id": "63caf7c7df3a7a236169a56c",
          "gateway_name": "EFTPOS_GATEWAY",
          "gateway_type": "EFTPOS",
          "vault_token": "20377dc6-bf91-4f65-b065-a3d75812179a",
          "card_name": "WANDA MERTZ",
          "card_number_bin": "41111111",
          "card_number_last4": "1111",
          "expire_month": 8,
          "expire_year": 2025
        }
      },
      "transactions": [
        {
          "_id": "63fd288edc1a690652970f4a",
          "external_id": "923114960953-738613",
          "external_reference": "923114960953",
          "currency": "AUD",
          "type": "verification",
          "status": "complete",
          "created_at": "2023-02-27T22:02:54.895Z",
          "updated_at": "2023-02-27T22:02:55.282Z",
          "_source_ip_address": "127.0.0.1"
        }
      ]
    }
  }
}