HEhelcim
Device

Start A Purchase

This operation requires the provided API key to have Processing permission set to 'PositiveTransaction' or higher.

post/devices/{code}/payment/purchase

Request

  • Base URL
    https://api.helcim.com/v2
  • URL
    https://api.helcim.com/v2/devices/{code}/payment/purchase
  • Auth
    API key in header api-token

Path parameters

codestring required

Four Digit Alphanumeric Code.

Request body

currencystring required

The currency code for the transaction amount, such as CAD or USD.

transactionAmountnumber required

The amount to be processed, specified in the currency defined by the currency parameter.

invoiceNumberstring

An identifier for an invoice. If an existing invoiceNumber is provided, Helcim will relate this transaction to that invoice. If invoiceNumber provided does not exist, Helcim will create an invoice and link the provided invoiceNumber. If not provided, Helcim will create an invoice.

customerCodestring

An identifier for a customer. If existing customerCode is provided, Helcim will attach that customer. If customerCode provided does not exist, Helcim will create a customer with the provided customerCode. If not provided, Helcim will create a customer.

Example request

{
  "currency": "CAD",
  "transactionAmount": 100.99,
  "invoiceNumber": "INV1000",
  "customerCode": "C-12345"
}

Response

Accepted

Changes

No recorded changes to this operation across all 2 revisions of this API.