v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Wallet Initialisation

Create a wallet token used to initialise a digital wallet in the Client SDK

post/v1/charges/wallet

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

currencystring required

Currency must always be set to AUD

referencestring

The reference identifier for the transaction

descriptionstring

A manually defined description for payments in payment systems

shippingobject

Response

200

statusinteger

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

Example response

{
  "status": 201,
  "resource": {
    "type": "charge",
    "data": {
      "token": "YOUR_WALLET_TOKEN",
      "charge": {
        "_id": "63fd93c3d8e7552c56047752",
        "amount": 1,
        "currency": "AUD",
        "reference": "2023-02-28T05:40:18.905Z",
        "company_id": "63cf32a154a870183bf2398a",
        "description": "2023-02-28T05:40:18.905Z",
        "type": "financial",
        "status": "wallet_initialized",
        "capture": true,
        "one_off": true,
        "created_at": "2023-02-28T05:40:19.545Z",
        "updated_at": "2023-02-28T05:40:19.545Z",
        "customer": {
          "payment_source": {
            "type": "wallet",
            "gateway_id": "YOUR_GATEWAY_ID",
            "gateway_name": "CommWeb",
            "gateway_type": "MasterCard"
          }
        }
      }
    }
  }
}