v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Create a payment

A Charge is a one-time payment that can be requested against any connected processing service.

post/v1/charges

Query parameters

captureboolean

Query parameter to specify immediate capture or pre-authorisation. Omitting this will default to true

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 transactions

currencystring required

The ISO4217 alpha-3 currency code

referencestring

A manually defined reference for payments in PowerBoard

tokenstring

The One-Time-Token returned from the PowerBoard widget or API

descriptionstring

Manually defined description for payments in payment systems

descriptorstring

Manually defined descriptor for payments in payment systems

Response

200

statusinteger

{"stackTrail":"paths:/v1/charges: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": {
        "first_name": "John",
        "last_name": "Smith",
        "email": "test@example.com",
        "reference": "customerRef1",
        "payment_source": {
          "vault_token": "YOUR_VAULT_TOKEN",
          "type": "card",
          "card_number_bin": "51111111",
          "card_number_last4": "1118",
          "card_scheme": "mastercard",
          "card_funding_method": "DEBIT",
          "expire_month": 1,
          "expire_year": 39,
          "gateway_id": "GATEWAY_ID",
          "gateway_type": "MasterCard",
          "gateway_name": "MasterCard",
          "vault_type": "session",
          "card_issuer": "FISERV SOLUTIONS, LLC"
        }
      },
      "_id": "67abd366de8d1e78cde5697b",
      "type": "financial",
      "amount": 110,
      "currency": "AUD",
      "status": "complete",
      "company_id": "649a6edfb848941bea648bd6",
      "capture": true,
      "description": "#4123728",
      "one_off": true,
      "reference": "reference1",
      "reference2": "ref2",
      "_source_ip_address": "130.41.233.1",
      "transactions": [
        {
          "created_at": "2025-02-11T22:47:02.839Z",
          "type": "sale",
          "status": "complete",
          "amount": 110,
          "currency": "AUD",
          "_source_ip_address": "130.41.233.1",
          "initialization_source": "internet",
          "first_payment": true,
          "_id": "67abd366de8d1e78cde5697c",
          "external_id": "a96706e2-e400-4a99-88b9-3c91034eff40:8554b9f7-c8a6-4dbe-9225-f424257118b0",
          "external_reference": "504222217638",
          "authorization_code": "217638",
          "processed_at": "2025-02-11T22:47:04.208Z"
        }
      ],
      "updated_at": "2025-02-11T22:47:04.208Z",
      "created_at": "2025-02-11T22:47:02.851Z",
      "external_id": "a96706e2-e400-4a99-88b9-3c91034eff40:8554b9f7-c8a6-4dbe-9225-f424257118b0"
    }
  }
}

All 27 operations