Skip to main content

Authorize.net

ToolJet supports the Authorize.net plugin to help you securely accept payments, manage customer profiles, and run end-to-end payment lifecycles directly from your applications. You can charge cards, save payment methods, handle refunds and voids, and manage tokenized customer profiles without writing backend code.

Configuration​

To configure the Authorize.net plugin in ToolJet, you will need the following credentials from your Authorize.net account:

  • API Login ID
  • Transaction Key
Authorize.net Configuration

You can generate these from the Authorize.net Merchant Interface → Settings → API Credentials & Keys section.

Supported Operation​

Charge a Credit Card​

Creates and submits an auth-and-capture transaction.

Request Body

{
  "amount": "5.00",
  "cardNumber": "4111111111111111",
  "expirationDate": "2025-12",
  "cardCode": "123",
  "refId": "123456",
  "lineItems": {
    "lineItem": [
      {
        "itemId": "1",
        "name": "Product Name",
        "description": "Product Description",
        "quantity": "1",
        "unitPrice": "5.00"
      }
    ]
  },
  "tax": {
    "amount": "0.50",
    "name": "Sales Tax",
    "description": "State Tax"
  },
  "billTo": {
    "firstName": "John",
    "lastName": "Doe",
    "address": "123 Main St",
    "city": "Seattle",
    "state": "WA",
    "zip": "98101",
    "country": "US"
  }
}

Authorize a Credit Card​

Places a hold on the amount without capturing the funds.

Request Body

{
  "amount": "5.00",
  "cardNumber": "4111111111111111",
  "expirationDate": "2025-12",
  "cardCode": "123",
  "refId": "123456",
  "lineItems": {
    "lineItem": [
      {
        "itemId": "1",
        "name": "Product Name",
        "description": "Product Description",
        "quantity": "1",
        "unitPrice": "5.00"
      }
    ]
  },
  "tax": {
    "amount": "0.50",
    "name": "Sales Tax",
    "description": "State Tax"
  },
  "billTo": {
    "firstName": "John",
    "lastName": "Doe",
    "address": "123 Main St",
    "city": "Seattle",
    "state": "WA",
    "zip": "98101",
    "country": "US"
  }
}

Capture a Previously Authorized Amount​

Captures funds from a previously authorized transaction.

Request Body

{
  "refTransId": "1234567890",
  "amount": "5.00",
  "refId": "123456"
}

Refund a Transaction​

Refunds a previously captured transaction.

Request Body

{
  "transId": "80048625878",
  "amount": "1.00",
  "cardNumber": "0015",
  "expirationDate": "XXXX"
}

Void a Transaction​

Voids an unsettled transaction.

Request Body

{
  "transId": "12345678",
  "refId": "optional-ref-123",
  "terminalNumber": "optional-terminal"
}

Charge a Customer Profile​

Charges a saved customer payment profile.

Request Body

{
  "customerProfileId": "40338125",
  "customerPaymentProfileId": "1000177237",
  "amount": "45.00",
  "refId": "123456",
  "lineItems": {
    "lineItem": [
      {
        "itemId": "1",
        "name": "vase",
        "description": "Cannes logo",
        "quantity": "18",
        "unitPrice": "45.00"
      }
    ]
  }
}

Create a Customer Profile​

Creates a new customer profile in Authorize.net.

Request Body

{
  "email": "[email protected]",
  "description": "Customer Name",
  "merchantCustomerId": "12345"
}

Get Customer Profile​

Fetches the details of an existing customer profile.

Request Body

{
  "customerProfileId": "123456",
  "refId": "ref123",
  "includeIssuerInfo": true
}

Get Customer Profile IDs​

Fetches all customer profile IDs.

  • No parameter needed.

Update Customer Profile​

Updates an existing customer profile.

Request Body

{
  "customerProfileId": "123456",
  "email": "[email protected]",
  "description": "Updated Name"
}

Delete Customer Profile​

Deletes an existing customer profile.

Request Body

{
  "customerProfileId": "123456"
}

Create Customer Payment Profile​

Creates a new payment profile under an existing customer profile.

Request Body

{
  "customerProfileId": "123456",
  "cardNumber": "4111111111111111",
  "expirationDate": "2025-12",
  "cardCode": "123",
  "billTo": {
    "firstName": "John",
    "lastName": "Doe",
    "address": "123 Main St",
    "city": "Bellevue",
    "state": "WA",
    "zip": "98004",
    "country": "US",
    "phoneNumber": "000-000-0000"
  },
  "defaultPaymentProfile": false,
  "validationMode": "liveMode"
}

Get Customer Payment Profile​

Fetches details of a specific payment profile.

Request Body

{
  "customerProfileId": "10000",
  "customerPaymentProfileId": "20000",
  "includeIssuerInfo": "true",
  "refId": "get-payment-001"
}

Validate Customer Payment Profile​

Validates a saved customer payment profile.

Request Body

{
  "customerProfileId": "123456",
  "customerPaymentProfileId": "234567",
  "validationMode": "testMode"
}

Update Customer Payment Profile​

Updates an existing customer payment profile.

Request Body

{
  "customerProfileId": "10000",
  "customerPaymentProfileId": "20000",
  "cardNumber": "4111111111111111",
  "expirationDate": "2026-01",
  "billTo": {
    "firstName": "John",
    "lastName": "Doe",
    "address": "123 Main St.",
    "city": "Bellevue",
    "state": "WA",
    "zip": "98004",
    "country": "US",
    "phoneNumber": "000-000-0000"
  },
  "defaultPaymentProfile": false,
  "validationMode": "liveMode"
}

Delete Customer Payment Profile​

Deletes a payment profile under a customer profile.

Request Body

{
  "customerProfileId": "123456",
  "customerPaymentProfileId": "234567",
  "refId": "delete-payment-001"
}

Create a Customer Profile from a Transaction​

Creates a customer and payment profile using a successful transaction.

Request Body

{
  "transId": "1234567890",
  "customer": {
    "merchantCustomerId": "CUST123",
    "description": "Customer description",
    "email": "[email protected]"
  },
  "profileType": "regular",
  "refId": "create-profile-001"
}