Skip to main content
POST
/
v1
/
transactions
/
credit
Credit
curl --request POST \
  --url https://api.ecrypt.com/v1/transactions/credit \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payment": {
    "token": "<string>",
    "stored": {
      "customer": "<string>",
      "wallet": "<string>",
      "installment": 123,
      "initialTransactionId": "<string>"
    },
    "terminal": {
      "id": "<string>",
      "externalIdentifier": "<string>",
      "promptTip": true,
      "tipAmounts": [
        123
      ],
      "promptCvv": true,
      "promptPostalCode": true,
      "promptAmountConfirmation": true,
      "promptSignature": true,
      "keyCard": true
    },
    "creditCard": {
      "accountNumber": "4111111111111111",
      "expires": "0135",
      "nameOnCard": "John Doe",
      "verificationValue": "000",
      "postalCode": "90210",
      "transactionId": "<string>"
    },
    "check": {
      "accountNumber": "<string>",
      "routingNumber": "<string>",
      "name": "<string>",
      "checkNumber": "<string>",
      "verification": {
        "dob": "<string>",
        "ssn": "<string>",
        "driversLicense": {
          "number": "<string>",
          "state": "<string>"
        }
      }
    },
    "cash": true,
    "creditCardEncrypted": "<string>",
    "googlePayPayment": {
      "signature": "<string>",
      "intermediateSigningKey": {
        "signedKey": "<string>",
        "signatures": [
          "<string>"
        ]
      },
      "protocolVersion": "<string>",
      "signedMessage": "<string>",
      "postalCode": "<string>",
      "nameOnCard": "<string>"
    }
  },
  "amount": {
    "value": 500000000
  },
  "order": {
    "customerPublicIdentifier": "<string>",
    "referenceObject": "<string>",
    "referenceObjectId": 123,
    "billTo": {
      "name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    },
    "shipTo": {
      "name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    },
    "discount": 123,
    "surcharge": 123,
    "shipping": 123,
    "email": "<string>",
    "tip": 123,
    "tax": 123,
    "total": 123,
    "date": "2023-11-07T05:31:56Z",
    "lines": [
      {
        "productCode": "<string>",
        "description": "<string>",
        "commodityCode": "<string>",
        "unitOfMeasure": "<string>",
        "unitCost": 123,
        "quantity": 123,
        "total": 123,
        "tax": 123,
        "taxRate": 123,
        "discount": 123,
        "discountRate": 123,
        "taxType": "<string>",
        "alternateTaxId": "<string>"
      }
    ],
    "metadata": {}
  },
  "initiatedByUserId": 123,
  "referenceTransactionId": 123
}
'
import requests

url = "https://api.ecrypt.com/v1/transactions/credit"

payload = {
"payment": {
"token": "<string>",
"stored": {
"customer": "<string>",
"wallet": "<string>",
"installment": 123,
"initialTransactionId": "<string>"
},
"terminal": {
"id": "<string>",
"externalIdentifier": "<string>",
"promptTip": True,
"tipAmounts": [123],
"promptCvv": True,
"promptPostalCode": True,
"promptAmountConfirmation": True,
"promptSignature": True,
"keyCard": True
},
"creditCard": {
"accountNumber": "4111111111111111",
"expires": "0135",
"nameOnCard": "John Doe",
"verificationValue": "000",
"postalCode": "90210",
"transactionId": "<string>"
},
"check": {
"accountNumber": "<string>",
"routingNumber": "<string>",
"name": "<string>",
"checkNumber": "<string>",
"verification": {
"dob": "<string>",
"ssn": "<string>",
"driversLicense": {
"number": "<string>",
"state": "<string>"
}
}
},
"cash": True,
"creditCardEncrypted": "<string>",
"googlePayPayment": {
"signature": "<string>",
"intermediateSigningKey": {
"signedKey": "<string>",
"signatures": ["<string>"]
},
"protocolVersion": "<string>",
"signedMessage": "<string>",
"postalCode": "<string>",
"nameOnCard": "<string>"
}
},
"amount": { "value": 500000000 },
"order": {
"customerPublicIdentifier": "<string>",
"referenceObject": "<string>",
"referenceObjectId": 123,
"billTo": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"shipTo": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"discount": 123,
"surcharge": 123,
"shipping": 123,
"email": "<string>",
"tip": 123,
"tax": 123,
"total": 123,
"date": "2023-11-07T05:31:56Z",
"lines": [
{
"productCode": "<string>",
"description": "<string>",
"commodityCode": "<string>",
"unitOfMeasure": "<string>",
"unitCost": 123,
"quantity": 123,
"total": 123,
"tax": 123,
"taxRate": 123,
"discount": 123,
"discountRate": 123,
"taxType": "<string>",
"alternateTaxId": "<string>"
}
],
"metadata": {}
},
"initiatedByUserId": 123,
"referenceTransactionId": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment: {
token: '<string>',
stored: {
customer: '<string>',
wallet: '<string>',
installment: 123,
initialTransactionId: '<string>'
},
terminal: {
id: '<string>',
externalIdentifier: '<string>',
promptTip: true,
tipAmounts: [123],
promptCvv: true,
promptPostalCode: true,
promptAmountConfirmation: true,
promptSignature: true,
keyCard: true
},
creditCard: {
accountNumber: '4111111111111111',
expires: '0135',
nameOnCard: 'John Doe',
verificationValue: '000',
postalCode: '90210',
transactionId: '<string>'
},
check: {
accountNumber: '<string>',
routingNumber: '<string>',
name: '<string>',
checkNumber: '<string>',
verification: {
dob: '<string>',
ssn: '<string>',
driversLicense: {number: '<string>', state: '<string>'}
}
},
cash: true,
creditCardEncrypted: '<string>',
googlePayPayment: {
signature: '<string>',
intermediateSigningKey: {signedKey: '<string>', signatures: ['<string>']},
protocolVersion: '<string>',
signedMessage: '<string>',
postalCode: '<string>',
nameOnCard: '<string>'
}
},
amount: {value: 500000000},
order: {
customerPublicIdentifier: '<string>',
referenceObject: '<string>',
referenceObjectId: 123,
billTo: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
shipTo: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
discount: 123,
surcharge: 123,
shipping: 123,
email: '<string>',
tip: 123,
tax: 123,
total: 123,
date: '2023-11-07T05:31:56Z',
lines: [
{
productCode: '<string>',
description: '<string>',
commodityCode: '<string>',
unitOfMeasure: '<string>',
unitCost: 123,
quantity: 123,
total: 123,
tax: 123,
taxRate: 123,
discount: 123,
discountRate: 123,
taxType: '<string>',
alternateTaxId: '<string>'
}
],
metadata: {}
},
initiatedByUserId: 123,
referenceTransactionId: 123
})
};

fetch('https://api.ecrypt.com/v1/transactions/credit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ecrypt.com/v1/transactions/credit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payment' => [
'token' => '<string>',
'stored' => [
'customer' => '<string>',
'wallet' => '<string>',
'installment' => 123,
'initialTransactionId' => '<string>'
],
'terminal' => [
'id' => '<string>',
'externalIdentifier' => '<string>',
'promptTip' => true,
'tipAmounts' => [
123
],
'promptCvv' => true,
'promptPostalCode' => true,
'promptAmountConfirmation' => true,
'promptSignature' => true,
'keyCard' => true
],
'creditCard' => [
'accountNumber' => '4111111111111111',
'expires' => '0135',
'nameOnCard' => 'John Doe',
'verificationValue' => '000',
'postalCode' => '90210',
'transactionId' => '<string>'
],
'check' => [
'accountNumber' => '<string>',
'routingNumber' => '<string>',
'name' => '<string>',
'checkNumber' => '<string>',
'verification' => [
'dob' => '<string>',
'ssn' => '<string>',
'driversLicense' => [
'number' => '<string>',
'state' => '<string>'
]
]
],
'cash' => true,
'creditCardEncrypted' => '<string>',
'googlePayPayment' => [
'signature' => '<string>',
'intermediateSigningKey' => [
'signedKey' => '<string>',
'signatures' => [
'<string>'
]
],
'protocolVersion' => '<string>',
'signedMessage' => '<string>',
'postalCode' => '<string>',
'nameOnCard' => '<string>'
]
],
'amount' => [
'value' => 500000000
],
'order' => [
'customerPublicIdentifier' => '<string>',
'referenceObject' => '<string>',
'referenceObjectId' => 123,
'billTo' => [
'name' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'shipTo' => [
'name' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'discount' => 123,
'surcharge' => 123,
'shipping' => 123,
'email' => '<string>',
'tip' => 123,
'tax' => 123,
'total' => 123,
'date' => '2023-11-07T05:31:56Z',
'lines' => [
[
'productCode' => '<string>',
'description' => '<string>',
'commodityCode' => '<string>',
'unitOfMeasure' => '<string>',
'unitCost' => 123,
'quantity' => 123,
'total' => 123,
'tax' => 123,
'taxRate' => 123,
'discount' => 123,
'discountRate' => 123,
'taxType' => '<string>',
'alternateTaxId' => '<string>'
]
],
'metadata' => [

]
],
'initiatedByUserId' => 123,
'referenceTransactionId' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.ecrypt.com/v1/transactions/credit"

payload := strings.NewReader("{\n \"payment\": {\n \"token\": \"<string>\",\n \"stored\": {\n \"customer\": \"<string>\",\n \"wallet\": \"<string>\",\n \"installment\": 123,\n \"initialTransactionId\": \"<string>\"\n },\n \"terminal\": {\n \"id\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"promptTip\": true,\n \"tipAmounts\": [\n 123\n ],\n \"promptCvv\": true,\n \"promptPostalCode\": true,\n \"promptAmountConfirmation\": true,\n \"promptSignature\": true,\n \"keyCard\": true\n },\n \"creditCard\": {\n \"accountNumber\": \"4111111111111111\",\n \"expires\": \"0135\",\n \"nameOnCard\": \"John Doe\",\n \"verificationValue\": \"000\",\n \"postalCode\": \"90210\",\n \"transactionId\": \"<string>\"\n },\n \"check\": {\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"checkNumber\": \"<string>\",\n \"verification\": {\n \"dob\": \"<string>\",\n \"ssn\": \"<string>\",\n \"driversLicense\": {\n \"number\": \"<string>\",\n \"state\": \"<string>\"\n }\n }\n },\n \"cash\": true,\n \"creditCardEncrypted\": \"<string>\",\n \"googlePayPayment\": {\n \"signature\": \"<string>\",\n \"intermediateSigningKey\": {\n \"signedKey\": \"<string>\",\n \"signatures\": [\n \"<string>\"\n ]\n },\n \"protocolVersion\": \"<string>\",\n \"signedMessage\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"nameOnCard\": \"<string>\"\n }\n },\n \"amount\": {\n \"value\": 500000000\n },\n \"order\": {\n \"customerPublicIdentifier\": \"<string>\",\n \"referenceObject\": \"<string>\",\n \"referenceObjectId\": 123,\n \"billTo\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipTo\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"discount\": 123,\n \"surcharge\": 123,\n \"shipping\": 123,\n \"email\": \"<string>\",\n \"tip\": 123,\n \"tax\": 123,\n \"total\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"lines\": [\n {\n \"productCode\": \"<string>\",\n \"description\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"unitOfMeasure\": \"<string>\",\n \"unitCost\": 123,\n \"quantity\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"taxRate\": 123,\n \"discount\": 123,\n \"discountRate\": 123,\n \"taxType\": \"<string>\",\n \"alternateTaxId\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"initiatedByUserId\": 123,\n \"referenceTransactionId\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.ecrypt.com/v1/transactions/credit")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payment\": {\n \"token\": \"<string>\",\n \"stored\": {\n \"customer\": \"<string>\",\n \"wallet\": \"<string>\",\n \"installment\": 123,\n \"initialTransactionId\": \"<string>\"\n },\n \"terminal\": {\n \"id\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"promptTip\": true,\n \"tipAmounts\": [\n 123\n ],\n \"promptCvv\": true,\n \"promptPostalCode\": true,\n \"promptAmountConfirmation\": true,\n \"promptSignature\": true,\n \"keyCard\": true\n },\n \"creditCard\": {\n \"accountNumber\": \"4111111111111111\",\n \"expires\": \"0135\",\n \"nameOnCard\": \"John Doe\",\n \"verificationValue\": \"000\",\n \"postalCode\": \"90210\",\n \"transactionId\": \"<string>\"\n },\n \"check\": {\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"checkNumber\": \"<string>\",\n \"verification\": {\n \"dob\": \"<string>\",\n \"ssn\": \"<string>\",\n \"driversLicense\": {\n \"number\": \"<string>\",\n \"state\": \"<string>\"\n }\n }\n },\n \"cash\": true,\n \"creditCardEncrypted\": \"<string>\",\n \"googlePayPayment\": {\n \"signature\": \"<string>\",\n \"intermediateSigningKey\": {\n \"signedKey\": \"<string>\",\n \"signatures\": [\n \"<string>\"\n ]\n },\n \"protocolVersion\": \"<string>\",\n \"signedMessage\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"nameOnCard\": \"<string>\"\n }\n },\n \"amount\": {\n \"value\": 500000000\n },\n \"order\": {\n \"customerPublicIdentifier\": \"<string>\",\n \"referenceObject\": \"<string>\",\n \"referenceObjectId\": 123,\n \"billTo\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipTo\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"discount\": 123,\n \"surcharge\": 123,\n \"shipping\": 123,\n \"email\": \"<string>\",\n \"tip\": 123,\n \"tax\": 123,\n \"total\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"lines\": [\n {\n \"productCode\": \"<string>\",\n \"description\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"unitOfMeasure\": \"<string>\",\n \"unitCost\": 123,\n \"quantity\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"taxRate\": 123,\n \"discount\": 123,\n \"discountRate\": 123,\n \"taxType\": \"<string>\",\n \"alternateTaxId\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"initiatedByUserId\": 123,\n \"referenceTransactionId\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ecrypt.com/v1/transactions/credit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment\": {\n \"token\": \"<string>\",\n \"stored\": {\n \"customer\": \"<string>\",\n \"wallet\": \"<string>\",\n \"installment\": 123,\n \"initialTransactionId\": \"<string>\"\n },\n \"terminal\": {\n \"id\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"promptTip\": true,\n \"tipAmounts\": [\n 123\n ],\n \"promptCvv\": true,\n \"promptPostalCode\": true,\n \"promptAmountConfirmation\": true,\n \"promptSignature\": true,\n \"keyCard\": true\n },\n \"creditCard\": {\n \"accountNumber\": \"4111111111111111\",\n \"expires\": \"0135\",\n \"nameOnCard\": \"John Doe\",\n \"verificationValue\": \"000\",\n \"postalCode\": \"90210\",\n \"transactionId\": \"<string>\"\n },\n \"check\": {\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"checkNumber\": \"<string>\",\n \"verification\": {\n \"dob\": \"<string>\",\n \"ssn\": \"<string>\",\n \"driversLicense\": {\n \"number\": \"<string>\",\n \"state\": \"<string>\"\n }\n }\n },\n \"cash\": true,\n \"creditCardEncrypted\": \"<string>\",\n \"googlePayPayment\": {\n \"signature\": \"<string>\",\n \"intermediateSigningKey\": {\n \"signedKey\": \"<string>\",\n \"signatures\": [\n \"<string>\"\n ]\n },\n \"protocolVersion\": \"<string>\",\n \"signedMessage\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"nameOnCard\": \"<string>\"\n }\n },\n \"amount\": {\n \"value\": 500000000\n },\n \"order\": {\n \"customerPublicIdentifier\": \"<string>\",\n \"referenceObject\": \"<string>\",\n \"referenceObjectId\": 123,\n \"billTo\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipTo\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"discount\": 123,\n \"surcharge\": 123,\n \"shipping\": 123,\n \"email\": \"<string>\",\n \"tip\": 123,\n \"tax\": 123,\n \"total\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"lines\": [\n {\n \"productCode\": \"<string>\",\n \"description\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"unitOfMeasure\": \"<string>\",\n \"unitCost\": 123,\n \"quantity\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"taxRate\": 123,\n \"discount\": 123,\n \"discountRate\": 123,\n \"taxType\": \"<string>\",\n \"alternateTaxId\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"initiatedByUserId\": 123,\n \"referenceTransactionId\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "requestId": "000000000000000000000",
  "transactionId": "<string>",
  "authCode": "<string>",
  "responseCode": "<string>",
  "responseText": "<string>",
  "latency": 123,
  "avs": {
    "code": "<string>",
    "text": "<string>"
  },
  "cvv": {
    "code": "<string>",
    "text": "<string>"
  },
  "amount": 123,
  "metadata": {},
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}
{
"requestId": "000000000000000000000",
"errors": [
{
"type": "<string>",
"message": "<unknown>"
}
]
}

Authorizations

x-api-key
string
header
required

Authorization by x-api-key inside request's header

Body

payment
object | null

Payment requires that you submit only one of the below options:

  • Token
  • Stored
  • Terminal,
  • Check
  • Cash
amount
object | null
order
object | null
initiatedByUserId
integer<int64> | null
referenceTransactionId
integer<int64> | null

Response

object | null

OK

requestId
string
default:000000000000000000000
required
Required string length: 1 - 100
transactionId
string
authCode
string
responseCode
string
responseText
string
latency
integer<int32>
avs
object | null
cvv
object | null
amount
number<decimal>
metadata
object | null
errors
(object | null)[] | null