Create a charge

POST /api/v5/Charge

cURL

cURL

curl --request POST \
  --url https://api-sandbox.paychoice.com.au/api/v5/Charge \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "amount": 123,
  "reference": "<string>",
  "card[name]": "<string>",
  "card[number]": "<string>",
  "card[expiry_month]": 123,
  "card[expiry_year]": 123,
  "card[cvv]": "<string>",
  "card_token": "<string>",
  "bank[name]": "<string>",
  "bank[bsb]": "<string>",
  "bank[number]": "<string>",
  "bank_token": "<string>",
  "pre_authid": "<string>",
  "merchant_guid": "<string>",
  "phone": "<string>",
  "charge_id": "<string>",
  "meta_data_reference": "<string>",
  "contact[phone]": "<string>",
  "contact[email]": "<string>",
  "address[address_line_1]": "<string>",
  "address[address_line_2]": "<string>",
  "address[suburb]": "<string>",
  "address[state]": "<string>",
  "address[post_code]": "<string>",
  "address[country]": "<string>",
  "3ds_charge_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "challenge_reference": "<string>"
}
'

200 — Approved

{
  "charge": {
    "id": "f33a990c-237c-4e88-9bd1-eb2d655bb88c",
    "reference": "INV-4325454",
    "amount": "10.00",
    "currency": "AUD",
    "status": "Approved",
    "status_code": "0",
    "error": "Transaction Approved",
    "error_code": "00",
    "created": "2026-11-04T02:15:31.118Z",
    "merchantguid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
    "aggregator_reference": "123456789012",
    "meta_data_reference": null,
    "link": { "href": "/api/v5/charge/f33a990c-237c-4e88-9bd1-eb2d655bb88c", "rel": "self" }
  },
  "object_type": "charge",
  "from_item": 0,
  "to_item": 0,
  "total_count": 0
}

Creates a charge against a credit card, a bank account, or a stored token. The same endpoint captures a pre-authorisation when pre_authid is supplied.

• Card: supply the card[...] fields or a card_token. Approved or declined immediately.
• Bank account: supply the bank[...] fields or a bank_token. Returns Processing ("9"); the final result arrives through the webhook.
• Capture: supply pre_authid from a pre-authorisation plus amount, currency and reference.

The JSON body uses the same bracketed key names as v4 form-data (card[name], bank[bsb]). Send them as literal keys.

A declined card charge returns HTTP 402 with the same charge object and the decline details in status, error and error_code. See the guide for the full walkthrough.

200 — Approved

{
  "charge": {
    "id": "f33a990c-237c-4e88-9bd1-eb2d655bb88c",
    "reference": "INV-4325454",
    "amount": "10.00",
    "currency": "AUD",
    "status": "Approved",
    "status_code": "0",
    "error": "Transaction Approved",
    "error_code": "00",
    "created": "2026-11-04T02:15:31.118Z",
    "merchantguid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
    "aggregator_reference": "123456789012",
    "meta_data_reference": null,
    "link": { "href": "/api/v5/charge/f33a990c-237c-4e88-9bd1-eb2d655bb88c", "rel": "self" }
  },
  "object_type": "charge",
  "from_item": 0,
  "to_item": 0,
  "total_count": 0
}

​

Response fields

charge.id · uuid

The charge ID. Use it to retrieve or refund the charge, and to match webhook notifications.

charge.reference · string

The reference you supplied.

charge.amount · string

Decimal with two places.

charge.currency · string

The currency you supplied.

charge.status · string

Approved, Dishonoured, Blocked, Errored or Processing.

charge.status_code · string

"0" Approved, "4" Blocked, "5" Dishonoured, "6" Errored, "9" Processing. See Charge status.

charge.error · string | null

Processor result description.

charge.error_code · string | null

Processor error code. See Errors.

charge.created · datetime

UTC.

charge.merchantguid · uuid

The merchant the charge belongs to.

charge.aggregator_reference · string | null

Processor reference.

charge.meta_data_reference · string | null

Any meta_data_reference supplied on the request.

charge.feeapplied / feeamount / orginal_amount

Present only when a surcharge was applied.

Authorizations

Authorization · string · header · required

Basic Authorization header using the Bearer scheme.

Body

application/jsontext/jsonapplication/*+json

currency · string | null

amount · number<double>

reference · string | null

card[name] · string | null

card[number] · string | null

card[expiry_month] · integer<int32>

card[expiry_year] · integer<int32>

card[cvv] · string | null

card_token · string | null

bank[name] · string | null

bank[bsb] · string | null

bank[number] · string | null

bank_token · string | null

pre_authid · string | null

merchant_guid · string | null

phone · string | null

charge_id · string | null

meta_data_reference · string | null

contact[phone] · string | null

contact[email] · string | null

address[address_line_1] · string | null

address[address_line_2] · string | null

address[suburb] · string | null

address[state] · string | null

address[post_code] · string | null

address[country] · string | null

3ds_charge_id · string<uuid> | null

challenge_reference · string | null

Response

200

OK