API Integration

Strictly's public API provides a set of endpoints that can be accessed with proper authentication. Below are the steps to integrate with the API.

Step 1: Obtain Your Security Credentials

1. Go to the Merchant Settings and select Security Keys.
2. You can create and view access keys on this page, specifying the user authorized to use the API. These keys are denoted as source: API.

Step 2: Call the API

For each API call, you will need the following:

• Security Key
• Username
• Password associated with the key

Important: API calls should be made from a server-side application as they involve sensitive information. Include the following headers in your request:

headers: {
  "authorization": "Basic {base64_encode(username:password)}",
  "key-hash": "your-security-key"
}

Authorization: The Basic Auth string is composed of the username and password encoded in Base64.

key-hash: The security key from your Merchant Settings.

API Request Example

Payment with Card

curl --location \
--request POST 'https://api.paywithzero.net/v1/public/payment/charge' \
--header 'Content-Type: application/json' \
--header 'key-hash: YJU56X2NKLVBFLHGEA7J' \
--header 'Authorization: Basic amxib3JyZXJvQGdtYWlsLmNvbToxcWF6eHN3Mg==' \
--data-raw '{
  "amount": 5,
  "contact": {
    "email": "demo@zerosurcharging.com",
    "phone": "5555555555"
  },
  "billingAddress": {
    "address": "demo",
    "city": "demo",
    "country": "US",
    "state": "Alaska",
    "zipCode": "10400"
  },
  "shippingAddress": {},
  "order": {
    "amount": 2,
    "shipping": 0,
    "tax": 0,
    "poNumber": "65614",
    "discount": 0
  },
  "capture": true,
  "card": {
    "name": "Demo Card",
    "paymentToken": "00000000-000000-000000-000000000000",
    "number": "411111******1111"
  }
}'

paymentToken: This will be generated by ZeroGateway.js and is usable only once.

Payment with Customer Vault

bash
Copy code
curl --location \
--request POST 'https://api.paywithzero.net/v1/public/payment/charge' \
--header 'Content-Type: application/json' \
--header 'key-hash: YJU56X2NKLVBFLHGEA7J' \
--header 'Authorization: Basic amxib3JyZXJvQGdtYWlsLmNvbToxcWF6eHN3Mg==' \
--data-raw '{
  "amount": 5,
  "contact": {
    "email": "demo@zerosurcharging.com",
    "phone": "5555555555"
  },
  "billingAddress": {
    "address": "demo",
    "city": "demo",
    "country": "US",
    "state": "Alaska",
    "zipCode": "10400"
  },
  "shippingAddress": {},
  "order": {
    "amount": 2,
    "shipping": 0,
    "tax": 0,
    "poNumber": "65614",
    "discount": 0
  },
  "capture": true,
  "card": {
    "vaultId": "6037d45411ccca001c4e4287"
  }
}'

Response Samples

Successful Response

{
  "data": {
    "id": "62264b0b15b2da2e2aa5c0d0",
    "object": "charge",
    "type": "sale",
    "amount": 5,
    "baseAmount": 5,
    "surcharge": 0,
    "captured": true,
    "transactionId": "7040635314",
    "error": false,
    "createdAt": "2022-03-07T18:12:27.512Z",
    "transactionAt": "2022-03-07T18:12:27.512Z",
    "settled": false,
    "userAgent": "curl/7.68.0",
    "device": "api",
    "paymentId": "62264b5f15b2da2e2aa5c0d2",
    "createdBy": "demo@zerosurcharging.com",
    "updatedBy": "demo@zerosurcharging.com"
  }
}

Error Response

json
Copy code
{
  "statusCode": 400,
  "timestamp": "2022-04-11T22:54:13.822Z",
  "path": "/v1/public/payment/charge",
  "response": {
    "code": "300",
    "text": "Transaction was rejected by gateway."
  },
  "message": "Http Exception"
}

Error Codes and Messages

Validation Rules

Use the above guidelines to integrate with the Strictly API efficiently and handle responses properly.