Start A Purchase

post

https://api.helcim.com/v2/devices/{code}/payment/purchase

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

Path Params

code

string

required

length ≤ 4

Four Digit Alphanumeric Code.

Body Params

currency

string

required

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

transactionAmount

number

required

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

invoiceNumber

string

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.

customerCode

string

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.

Responses

202

Accepted

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

403Unauthorized

404Device Not Found

409Device Not Listening

500Internal server error