EveryPay

https://support.every-pay.com/apidoc/main/
Admin
EveryPay is a payment gateway API platform that enables secure card payments, open banking...
Tokens:74,669
Snippets:252
Trust Score:8.7
Update:7 months ago
Show doc for...
Tokens:
Raw
### Initiate Credit Payment Request Samples

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Provides sample code for initiating a credit payment request using the EveryPay API. Examples are available for Node.js, Ruby, PHP, and shell environments, demonstrating how to structure the request payload.

```javascript
// Node.js Example (Conceptual)
const payload = {
  "account_name": "EUR3D1",
  "nonce": "165784ab51fkm",
  "timestamp": "2023-12-05T10:27:32Z",
  "amount": 0.05,
  "order_reference": "84005a6c",
  "email": "example@gmail.com",
  "customer_url": "https://example.com",
  "api_username": "a04e7ce1060e7024",
  "billing_city": "Tallinn",
  "billing_country": "EE",
  "billing_line1": "Tartu mnt 2",
  "billing_postcode": 10145,
  "billing_state": "EE-37"
};
// Use a library like 'axios' or 'node-fetch' to send a POST request to the API endpoint.
```

```ruby
# Ruby Example (Conceptual)
require 'json'

payload = {
  "account_name": "EUR3D1",
  "nonce": "165784ab51fkm",
  "timestamp": "2023-12-05T10:27:32Z",
  "amount": 0.05,
  "order_reference": "84005a6c",
  "email": "example@gmail.com",
  "customer_url": "https://example.com",
  "api_username": "a04e7ce1060e7024",
  "billing_city": "Tallinn",
  "billing_country": "EE",
  "billing_line1": "Tartu mnt 2",
  "billing_postcode": 10145,
  "billing_state": "EE-37"
}

# Use a library like 'net/http' or 'httparty' to send a POST request to the API endpoint.
```

```php
// PHP Example (Conceptual)
<?php
$payload = [
  "account_name" => "EUR3D1",
  "nonce" => "165784ab51fkm",
  "timestamp" => "2023-12-05T10:27:32Z",
  "amount" => 0.05,
  "order_reference" => "84005a6c",
  "email" => "example@gmail.com",
  "customer_url" => "https://example.com",
  "api_username" => "a04e7ce1060e7024",
  "billing_city" => "Tallinn",
  "billing_country" => "EE",
  "billing_line1" => "Tartu mnt 2",
  "billing_postcode" => 10145,
  "billing_state" => "EE-37"
];

// Use cURL or a library like Guzzle to send a POST request to the API endpoint.
?>
```

```shell
# Shell Example (using curl)
curl -X POST https://igw-demo.every-pay.com/api/v4/payments/credit \
-H "Content-Type: application/json" \
-d '{ 
  "account_name": "EUR3D1",
  "nonce": "165784ab51fkm",
  "timestamp": "2023-12-05T10:27:32Z",
  "amount": 0.05,
  "order_reference": "84005a6c",
  "email": "example@gmail.com",
  "customer_url": "https://example.com",
  "api_username": "a04e7ce1060e7024",
  "billing_city": "Tallinn",
  "billing_country": "EE",
  "billing_line1": "Tartu mnt 2",
  "billing_postcode": 10145,
  "billing_state": "EE-37" 
}'
```

--------------------------------

### Initiate Credit Payment Request (Node.js)

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Example of how to initiate a credit payment using the EveryPay API with Node.js. This snippet demonstrates setting up the request URL, headers, and body for a POST request. Ensure to replace 'REPLACE_BASIC_AUTH' with your actual Basic Authentication credentials.

```Node
const fetch = require('node-fetch');

let url = 'https://igw-demo.every-pay.com/api/v4/payments/credit';

let options = {
  method: 'POST',
  headers: {Authorization: 'Basic REPLACE_BASIC_AUTH', 'content-type': 'application/json'},

```

--------------------------------

### Get Processing Accounts List - Node.js Request Sample

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

This snippet demonstrates how to retrieve a list of available processing accounts using Node.js. It utilizes the 'node-fetch' library to make a GET request to the EveryPay API. Ensure you replace 'SOME_STRING_VALUE' with your actual api_username and 'REPLACE_BASIC_AUTH' with your basic authentication token.

```javascript
const fetch = require('node-fetch');

let url = 'https://igw-demo.every-pay.com/api/v4/processing_accounts?api_username=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Basic REPLACE_BASIC_AUTH'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

--------------------------------

### Get Shops List

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Retrieve a list of shops with their primary configuration parameters. This endpoint requires merchant authentication.

```APIDOC
## GET /v4/shops

### Description
Retrieve a list of shops with their primary configuration parameters.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/shops
https://pay.every-pay.eu/api/v4/shops

### Parameters
#### Query Parameters
- **api_username** (string) - Required - The api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header (16 characters)

### Request Example
```javascript
const fetch = require('node-fetch');

let url = 'https://igw-demo.every-pay.com/api/v4/shops?api_username=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Basic REPLACE_BASIC_AUTH'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response
#### Success Response (200)
- **api_username** (string) - The api username of the merchant.
- **shops** (array) - A list of shop objects.
  - **id** (integer) - The unique identifier for the shop.
  - **url** (string) - The URL associated with the shop.
  - **descriptor** (string) - A descriptor for the shop.
  - **mcc** (string) - The Merchant Category Code for the shop.

#### Response Example
```json
{
  "api_username": "a04e7ce1060e7024",
  "shops": [
    {
      "id": 5712,
      "url": "https://example.com",
      "descriptor": "example.com",
      "mcc": "5999"
    }
  ]
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
```

--------------------------------

### Request Samples for Sending Card Details (Multiple Languages)

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Various request samples for sending card details via the EveryPay API, provided in different programming languages. These examples demonstrate how to structure the request payload for different environments.

```json
{
  "api_username": "a04e7ce1060e7024",
  "token_consented": true,
  "timestamp": "2023-12-05T10:27:32Z",
  "cc_details": {
    "cc_number": 5168830759303438,
    "month": 12,
    "year": 2025,
    "holder_name": "John Doe",
    "cvc": 418
  }
}
```

```node
// Node.js example (conceptual)
const payload = {
  api_username: "a04e7ce1060e7024",
  token_consented: true,
  timestamp: "2023-12-05T10:27:32Z",
  cc_details: {
    cc_number: 5168830759303438,
    month: 12,
    year: 2025,
    holder_name: "John Doe",
    cvc: 418
  }
};
// Use fetch or axios to send this payload to the API endpoint
```

```ruby
# Ruby example (conceptual)
payload = {
  api_username: "a04e7ce1060e7024",
  token_consented: true,
  timestamp: "2023-12-05T10:27:32Z",
  cc_details: {
    cc_number: 5168830759303438,
    month: 12,
    year: 2025,
    holder_name: "John Doe",
    cvc: 418
  }
}
# Use Net::HTTP or other libraries to send this payload to the API endpoint
```

```php
// PHP example (conceptual)
$payload = [
  'api_username' => 'a04e7ce1060e7024',
  'token_consented' => true,
  'timestamp' => '2023-12-05T10:27:32Z',
  'cc_details' => [
    'cc_number' => 5168830759303438,
    'month' => 12,
    'year' => 2025,
    'holder_name' => 'John Doe',
    'cvc' => 418
  ]
];
// Use cURL or Guzzle to send this payload to the API endpoint
```

```shell
# Shell example using cURL
curl -X POST https://igw-demo.every-pay.com/api/v4/mobile_payments/card_details \
-H "Content-Type: application/json" \
-d '{ 
  "api_username": "a04e7ce1060e7024",
  "token_consented": true,
  "timestamp": "2023-12-05T10:27:32Z",
  "cc_details": {
    "cc_number": 5168830759303438,
    "month": 12,
    "year": 2025,
    "holder_name": "John Doe",
    "cvc": 418
  }
}'
```

--------------------------------

### Capture Payment Response Sample (JSON)

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Example of a successful response (201) when capturing a payment via the EveryPay API. Includes details like initial amount, standing amount, payment reference, transaction time, and payment state.

```json
{
  "api_username": "a04e7ce1060e7024",
  "initial_amount": 0.05,
  "standing_amount": 0.05,
  "payment_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  "transaction_time": "2023-12-07T08:38:27.266Z",
  "payment_state": "settled"
}
```

--------------------------------

### Retrieve Payment Details (Shell)

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

This command-line snippet shows how to fetch payment details using cURL. It specifies the HTTP method as GET, the URL for the API endpoint, and includes the necessary Authorization header. This is a straightforward way to test or interact with the payment retrieval API from a terminal.

```Shell
curl --request GET \
  --url 'https://igw-demo.every-pay.com/api/v4/payments/%7Bpayment_reference%7D?api_username=SOME_STRING_VALUE&detailed=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH'
```

--------------------------------

### Get Agreement Status Request Sample (Node.js)

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

This Node.js code snippet demonstrates how to retrieve the current status of a payment agreement using the GET /v4/agreements/{agreement_reference} endpoint. It requires the agreement reference, API username, and basic authentication credentials.

```javascript
const fetch = require('node-fetch');

let url = 'https://igw-demo.every-pay.com/api/v4/agreements/%7Bagreement_reference%7D?api_username=SOME_STRING_VALUE&detailed=SOME_BOOLEAN_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Basic REPLACE_BASIC_AUTH'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

--------------------------------

### GET /api/v4/shops

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Retrieve a list of all shops associated with the authenticated merchant.

```APIDOC
## GET /api/v4/shops

### Description
Retrieve a list of all shops configured for the merchant.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/shops

### Parameters
#### Query Parameters
- **api_username** (string) - Required - The api_username of the Merchant sending the request.

### Request Example
GET /api/v4/shops?api_username=SOME_STRING_VALUE

### Response
#### Success Response (200)
- **shops** (array) - List of shop objects.

#### Response Example
{
  "shops": []
}
```

--------------------------------

### Initiate CIT Payment with Node.js

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Demonstrates how to perform a POST request to the EveryPay CIT payment endpoint using the node-fetch library. It requires Basic Authentication and a JSON-formatted body containing payment and integration details.

```Node
const fetch = require('node-fetch');

let url = 'https://igw-demo.every-pay.com/api/v4/payments/cit';

let options = {
  method: 'POST',
  headers: {Authorization: 'Basic REPLACE_BASIC_AUTH', 'content-type': 'application/json'}
};
```

--------------------------------

### Initiate One-Off Payment with cURL

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

This command-line snippet shows how to initiate a one-off payment using cURL. It specifies the API endpoint, HTTP method, required headers (Authorization and content-type), and the JSON payload containing all necessary payment details. This is useful for testing API interactions directly from the terminal.

```shell
curl --request POST \
  --url https://igw-demo.every-pay.com/api/v4/payments/oneoff \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json' \
  --data '{"structured_reference":5705872,"payment_description":"example.com 84005a6c","account_name":"EUR3D1","nonce":"165784ab51fkm","timestamp":"2023-12-05T10:27:32Z","amount":0.05,"order_reference":"84005a6c","request_token":true,"token_agreement":"unscheduled","email":"example@gmail.com","phone_number":{"country_code":372,"number":7878419},"customer_ip":"53.62.137.190","customer_url":"https://example.com","locale":"et","api_username":"a04e7ce1060e7024","preferred_country":"EE","billing_city":"Tallinn","billing_country":"EE","billing_line1":"Tartu mnt 2","billing_line2":null,"billing_line3":null,"billing_postcode":10145,"billing_state":"EE-37","shipping_city":"Tallinn","shipping_country":"EE","shipping_line1":"Tartu mnt 2","shipping_line2":null,"shipping_line3":null,"shipping_postcode":10145,"shipping_state":"EE-37","mobile_payment":true,"token_consent_agreed":true,"integration_details":{"integration":"Custom","software":"eCommerce","version":2.1}}'
```

--------------------------------

### GET /v4/processing_accounts

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Retrieve a detailed list of available processing accounts and payment methods.

```APIDOC
## GET /v4/processing_accounts

### Description
Retrieve a detailed list of available processing accounts and payment methods.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/processing_accounts

### Parameters
#### Query Parameters
- **api_username** (string) - Required - The api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header (16 characters).

### Request Example
GET /v4/processing_accounts?api_username=SOME_STRING_VALUE

### Response
#### Success Response (200)
- **data** (array) - List of processing account objects.

#### Response Example
{
  "processing_accounts": [
    {
      "account_name": "example_account",
      "payment_methods": ["card", "bank_link"]
    }
  ]
}
```

--------------------------------

### Initiate One-Off Payment with PHP cURL

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

This snippet demonstrates how to initiate a one-off payment using PHP's cURL library. It includes setting various payment parameters such as amount, currency, customer details, and order references. The response from the API is then displayed, or any cURL errors are reported.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://igw-demo.every-pay.com/api/v4/payments/oneoff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"structured_reference\":5705872,\"payment_description\":\"example.com 84005a6c\",\"account_name\":\"EUR3D1\",\"nonce\":\"165784ab51fkm\",\"timestamp\":\"2023-12-05T10:27:32Z\",\"amount\":0.05,\"order_reference\":\"84005a6c\",\"request_token\":true,\"token_agreement\":\"unscheduled\",\"email\":\"example@gmail.com\",\"phone_number\":{\"country_code\":372,\"number\":7878419},\"customer_ip\":\"53.62.137.190\",\"customer_url\":\"https://example.com\",\"locale\":\"et\",\"api_username\":\"a04e7ce1060e7024\",\"preferred_country\":\"EE\",\"billing_city\":\"Tallinn\",\"billing_country\":\"EE\",\"billing_line1\":\"Tartu mnt 2\",\"billing_line2\":null,\"billing_line3\":null,\"billing_postcode\":10145,\"billing_state\":\"EE-37\",\"shipping_city\":\"Tallinn\",\"shipping_country\":\"EE\",\"shipping_line1\":\"Tartu mnt 2\",\"shipping_line2\":null,\"shipping_line3\":null,\"shipping_postcode\":10145,\"shipping_state\":\"EE-37\",\"mobile_payment\":true,\"token_consent_agreed\":true,\"integration_details\":{\"integration\":\"Custom\",\"software\":\"eCommerce\",\"version\":2.1}}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic REPLACE_BASIC_AUTH",
    "content-type: application/json"
  ],
]);

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

curl_close($curl);

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

```

--------------------------------

### GET /agreements/{agreement_reference}

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Retrieves the current status and details of a specific payment agreement.

```APIDOC
## GET /agreements/{agreement_reference}

### Description
Retrieves comprehensive details about an agreement, including its current state, fraud score, and payment links.

### Method
GET

### Endpoint
/agreements/{agreement_reference}

### Parameters
#### Path Parameters
- **agreement_reference** (string) - Required - The unique reference ID of the agreement.

### Response
#### Success Response (200)
- **agreement_reference** (string) - Unique reference ID of the agreement.
- **agreement_state** (string) - Current status of the agreement (e.g., initial).
- **payment_link** (string) - Link to complete the agreement.
- **fraudulent** (boolean) - Flag indicating if the agreement is marked as fraudulent.
- **type** (string) - The type of the Agreement (e.g., ob_periodic_payment).

#### Response Example
{
  "agreement_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  "agreement_state": "initial",
  "payment_link": "https://pay.every-pay.eu/lp/x419d7/3HeCGV01",
  "fraudulent": false,
  "type": "ob_periodic_payment"
}
```

--------------------------------

### Payment Status Reference

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

A reference guide for the various states a payment can transition through during its lifecycle.

```APIDOC
## Payment Statuses

### Overview
EveryPay payments transition through specific states from initiation to final settlement or failure.

### Status List
- **Initial**: Payment initiated, method not yet selected.
- **Waiting for 3DS**: Awaiting 3D Secure authentication.
- **Waiting for SCA**: Awaiting Strong Customer Authentication for Open Banking.
- **Sent for processing**: Confirmed by customer, awaiting bank confirmation.
- **Abandoned**: Process timed out or abandoned by user.
- **Failed**: Technical error or authorization decline.
- **Settled**: Final state; funds transferred.
- **Authorised**: Payment approved and funds reserved.
- **Voided**: Authorization cancelled.
- **Refunded**: Partial or full reimbursement.
- **Charged Back**: Payment disputed by cardholder.
- **3DS Confirmed**: 3DS complete, but processing halted due to error.
```

--------------------------------

### Initiate Payment with EveryPay API

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

This snippet shows how to initiate a payment using the EveryPay API. It requires constructing a JSON payload with payment details and making a POST request to the specified API endpoint. Ensure to replace 'REPLACE_BASIC_AUTH' with your actual Basic Authentication credentials.

```JavaScript
const url = "https://igw-demo.every-pay.com/api/v4/payments/cit";
            const options = {
              method: "POST",
              headers: {
                "Authorization": "Basic REPLACE_BASIC_AUTH",
                "content-type": "application/json"
              },
              body: '{"account_name":"EUR3D1","nonce":"165784ab51fkm","timestamp":"2023-12-05T10:27:32Z","order_reference":"84005a6c","email":"example@gmail.com","phone_number":{"country_code":372,"number":7878419},"customer_ip":"53.62.137.190","customer_url":"https://example.com","locale":"et","api_username":"a04e7ce1060e7024","billing_city":"Tallinn","billing_country":"EE","billing_line1":"Tartu mnt 2","billing_line2":null,"billing_line3":null,"billing_postcode":10145,"billing_state":"EE-37","shipping_city":"Tallinn","shipping_country":"EE","shipping_line1":"Tartu mnt 2","shipping_line2":null,"shipping_line3":null,"shipping_postcode":10145,"shipping_state":"EE-37","token_agreement":"unscheduled","amount":0.05,"integration_details":{"integration":"Custom","software":"eCommerce","version":2.1}}'
            };

            fetch(url, options)
              .then(res => res.json())
              .then(json => console.log(json))
              .catch(err => console.error('error:' + err));
```

```Ruby
require 'uri'

require 'net/http'

require 'openssl'


url = URI("https://igw-demo.every-pay.com/api/v4/payments/cit")


http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE


request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic REPLACE_BASIC_AUTH'
request["content-type"] = 'application/json'
request.body =
  "{\"account_name\":\"EUR3D1\",\"nonce\":\"165784ab51fkm\",\"timestamp\":\"2023-12-05T10:27:32Z\",\"order_reference\":\"84005a6c\",\"email\":\"example@gmail.com\",\"phone_number\":{\"country_code\":372,\"number\":7878419},\"customer_ip\":\"53.62.137.190\",\"customer_url\":\"https://example.com\",\"locale\":\"et\",\"api_username\":\"a04e7ce1060e7024\",\"billing_city\":\"Tallinn\",\"billing_country\":\"EE\",\"billing_line1\":\"Tartu\n mnt\n 2\",\"billing_line2\":null,\"billing_line3\":null,\"billing_postcode\":10145,\"billing_state\":\"EE-37\",\"shipping_city\":\"Tallinn\",\"shipping_country\":\"EE\",\"shipping_line1\":\"Tartu\n mnt\n 2\",\"shipping_line2\":null,\"shipping_line3\":null,\"shipping_postcode\":10145,\"shipping_state\":\"EE-37\",\"token_agreement\":\"unscheduled\",\"amount\":0.05,\"integration_details\":{\"integration\":\"Custom\",\"software\":\"eCommerce\",\"version\":2.1}}"


response = http.request(request)
puts response.read_body
```

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://igw-demo.every-pay.com/api/v4/payments/cit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"account_name\":\"EUR3D1\",\"nonce\":\"165784ab51fkm\",\"timestamp\":\"2023-12-05T10:27:32Z\",\"order_reference\":\"84005a6c\",\"email\":\"example@gmail.com\",\"phone_number\":{\"country_code\":372,\"number\":7878419},\"customer_ip\":\"53.62.137.190\",\"customer_url\":\"https://example.com\",\"locale\":\"et\",\"api_username\":\"a04e7ce1060e7024\",\"billing_city\":\"Tallinn\",\"billing_country\":\"EE\",\"billing_line1\":\"Tartu mnt 2\",\"billing_line2\":null,\"billing_line3\":null,\"billing_postcode\":10145,\"billing_state\":\"EE-37\",\"shipping_city\":\"Tallinn\",\"shipping_country\":\"EE\",\"shipping_line1\":\"Tartu mnt 2\",\"shipping_line2\":null,\"shipping_line3\":null,\"shipping_postcode\":10145,\"shipping_state\":\"EE-37\",\"token_agreement\":\"unscheduled\",\"amount\":0.05,\"integration_details\":{\"integration\":\"Custom\",\"software\":\"eCommerce\",\"version\":2.1}}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic REPLACE_BASIC_AUTH",
    "content-type: application/json"
  ],
]);

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

curl_close($curl);

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

```

```Shell
curl --request POST \
  --url https://igw-demo.every-pay.com/api/v4/payments/cit \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json' \
  --data '{"account_name":"EUR3D1","nonce":"165784ab51fkm","timestamp":"2023-12-05T10:27:32Z","order_reference":"84005a6c","email":"example@gmail.com","phone_number":{"country_code":372,"number":7878419},"customer_ip":"53.62.137.190","customer_url":"https://example.com","locale":"et","api_username":"a04e7ce1060e7024","billing_city":"Tallinn","billing_country":"EE","billing_line1":"Tartu mnt 2","billing_line2":null,"billing_line3":null,"billing_postcode":10145,"billing_state":"EE-37","shipping_city":"Tallinn","shipping_country":"EE","shipping_line1":"Tartu mnt 2","shipping_line2":null,"shipping_line3":null,"shipping_postcode":10145,"shipping_state":"EE-37","token_agreement":"unscheduled","amount":0.05,"integration_details":{"integration":"Custom","software":"eCommerce","version":2.1}}'
```

--------------------------------

### GET /api/v4/agreements/{agreement_reference}

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Retrieves the current status of an existing agreement using its reference ID.

```APIDOC
## GET /api/v4/agreements/{agreement_reference}

### Description
Retrieves the current state of the agreement. It should be checked whenever a Callback is received to obtain the latest information about the agreement.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/agreements/{agreement_reference}

### Parameters
#### Path Parameters
- **agreement_reference** (string) - Required - The unique ID of the agreement.

#### Query Parameters
- **api_username** (string) - Required - The API username of the Merchant.

### Response
#### Success Response (200)
- **status** (string) - The current status of the agreement.
```

--------------------------------

### Capture Payment Request Samples (JSON, Node, Ruby, PHP, Shell)

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Provides sample request payloads for capturing a payment via the EveryPay API. Supports JSON format and examples for Node.js, Ruby, PHP, and Shell clients. Requires API username, amount, timestamp, payment reference, and nonce.

```json
{
  "api_username": "a04e7ce1060e7024",
  "amount": 0.05,
  "timestamp": "2023-12-05T10:27:32Z",
  "payment_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  "nonce": "165784ab51fkm"
}
```

```javascript
const payload = {
  api_username: "a04e7ce1060e7024",
  amount: 0.05,
  timestamp: "2023-12-05T10:27:32Z",
  payment_reference: "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  nonce: "165784ab51fkm"
};
// Further Node.js implementation...
```

```ruby
payload = {
  api_username: "a04e7ce1060e7024",
  amount: 0.05,
  timestamp: "2023-12-05T10:27:32Z",
  payment_reference: "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  nonce: "165784ab51fkm"
}
# Further Ruby implementation...
```

```php
$payload = [
    "api_username" => "a04e7ce1060e7024",
    "amount" => 0.05,
    "timestamp" => "2023-12-05T10:27:32Z",
    "payment_reference" => "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
    "nonce" => "165784ab51fkm"
];
// Further PHP implementation...
```

```shell
curl -X POST https://igw-demo.every-pay.com/api/v4/payments/capture \
-H "Content-Type: application/json" \
-d '{
  "api_username": "a04e7ce1060e7024",
  "amount": 0.05,
  "timestamp": "2023-12-05T10:27:32Z",
  "payment_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  "nonce": "165784ab51fkm"
}'
```

--------------------------------

### GET /api/v4/payments/{payment_reference}

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Retrieves the current status of a specific payment using its reference ID.

```APIDOC
## GET /api/v4/payments/{payment_reference}

### Description
Retrieves the current state of the payment. This should be checked upon receiving a callback to ensure the latest information is obtained.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/payments/{payment_reference}

### Parameters
#### Path Parameters
- **payment_reference** (string) - Required - The unique reference ID of the payment.

#### Query Parameters
- **api_username** (string) - Required - The Merchant API username.
- **detailed** (boolean) - Optional - If true, returns fraud check details.

### Response
#### Success Response (200)
- **status** (string) - The current status of the payment.

### Response Example
{
  "payment_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  "status": "settled"
}
```

--------------------------------

### Initiate Periodic Payment Response Sample (201)

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

This is a sample JSON response for a successful initiation of a periodic payment (HTTP status code 201). It includes details about the created agreement, payment methods, and links for further actions.

```json
{
  "account_name": "EUR3D1",
  "order_reference": "84005a6c",
  "email": "example@gmail.com",
  "customer_ip": "1.2.3.4",
  "customer_url": "https://example.com",
  "created_at": "2023-12-05T10:27:32Z",
  "agreement_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
  "payment_link": "https://pay.every-pay.eu/lp/x419d7/3HeCGV01",
  "payment_methods": [
    {
      "source": "lhv_ob_ee",
      "display_name": "AS LHV Pank",
      "country_code": "EE",
      "payment_link": null,
      "logo_url": "https://igw-demo.every-pay.com/assets/payment_methods/seb-8099b005a2a78dab9b2002ee1d53da9f8960f78e5dbd4b19054daeef27819fcf.svg",
      "tokenization_supported": true,
      "agreements_supported": false
    }
  ],
  "api_username": "a04e7ce1060e7024",
  "agreement_state": "initial",
  "frequency": "monthly",
  "start_date": "2024-10-30",
  "end_date": "2030-10-30"
}
```

--------------------------------

### GET /v4/agreements/{agreement_reference}

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Retrieves the current state of an existing agreement using its reference ID.

```APIDOC
## GET /v4/agreements/{agreement_reference}

### Description
Retrieves the current state of the agreement. It should be checked whenever a Callback is received.

### Method
GET

### Endpoint
/v4/agreements/{agreement_reference}

### Parameters
#### Path Parameters
- **agreement_reference** (string) - Required - Reference ID of the agreement

#### Query Parameters
- **api_username** (string) - Required - The API username of the Merchant
- **detailed** (boolean) - Optional - Include fraud check details

### Response
#### Success Response (200)
- **agreement_state** (string) - Current state of the agreement
- **account_name** (string) - Account identifier

#### Response Example
{
  "agreement_state": "initial",
  "account_name": "EUR3D1"
}
```

--------------------------------

### Refund Payment using EveryPay API (Node.js, PHP, Shell)

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Demonstrates how to initiate a payment refund through the EveryPay API. This involves sending a POST request with payment details and API credentials. Ensure 'REPLACE_BASIC_AUTH' is replaced with actual Basic Authentication credentials.

```Node.js
const fetch = require('node-fetch');

let url = 'https://igw-demo.every-pay.com/api/v4/payments/refund';

let options = {
  method: 'POST',
  headers: {
    'Authorization': 'Basic REPLACE_BASIC_AUTH',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    "api_username": "a04e7ce1060e7024",
    "amount": 0.05,
    "timestamp": "2023-12-05T10:27:32Z",
    "payment_reference": "0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a",
    "nonce": "165784ab51fkm"
  })
};

fetch(url, options)
  .then(res => res.text())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://igw-demo.every-pay.com/api/v4/payments/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"api_username\":\"a04e7ce1060e7024\",\"amount\":0.05,\"timestamp\":\"2023-12-05T10:27:32Z\",\"payment_reference\":\"0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a\",\"nonce\":\"165784ab51fkm\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic REPLACE_BASIC_AUTH",
    "content-type: application/json"
  ],
]);

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

curl_close($curl);

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

```Shell
curl --request POST \
  --url https://igw-demo.every-pay.com/api/v4/payments/refund \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json' \
  --data '{"api_username":"a04e7ce1060e7024","amount":0.05,"timestamp":"2023-12-05T10:27:32Z","payment_reference":"0a887489dd023f1affd5dd0735a9766415c96d9314b738da8c7117e24216d62a","nonce":"165784ab51fkm"}'
```

--------------------------------

### GET /v4/processing_accounts/{account_name}

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Retrieve detailed configuration and payment methods for a specific processing account.

```APIDOC
## GET /v4/processing_accounts/{account_name}

### Description
Retrieve details of a specific processing account, including available payment methods and configuration settings.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/processing_accounts/{account_name}

### Parameters
#### Path Parameters
- **account_name** (string) - Required - Processing account ID

#### Query Parameters
- **api_username** (string) - Required - The API username of the Merchant sending the request.
- **amount** (number) - Optional - By sending amount, payment methods will be returned according to the limits configured in the Merchant portal.

### Request Example
```
GET /api/v4/processing_accounts/EUR3D1?api_username=a04e7ce1060e7024&amount=10.00
```

### Response
#### Success Response (200)
- **account_name** (string) - Account name
- **payment_methods** (array) - List of available payment methods

#### Response Example
{
  "account_name": "EUR3D1",
  "pre_authorisation": false,
  "currency": "EUR",
  "payment_methods": [
    {
      "source": "card",
      "display_name": "VISA/MasterCard",
      "tokenization_supported": true
    }
  ]
}
```

--------------------------------

### Process Credit Payments via EveryPay API

Source: https://support.every-pay.com/apidoc/main/openapi.yaml

Demonstrates how to initiate a credit payment by sending a JSON payload to the /api/v4/payments/credit endpoint. Requires Basic Authentication and includes customer billing details and order information.

```JavaScript
const options = {
  method: 'POST',
  headers: {'content-type': 'application/json', 'Authorization': 'Basic REPLACE_BASIC_AUTH'},
  body: '{"account_name":"EUR3D1","nonce":"165784ab51fkm","timestamp":"2023-12-05T10:27:32Z","amount":0.05,"order_reference":"84005a6c","email":"example@gmail.com","customer_url":"https://example.com","api_username":"a04e7ce1060e7024","billing_city":"Tallinn","billing_country":"EE","billing_line1":"Tartu mnt 2","billing_line2":null,"billing_line3":null,"billing_postcode":10145,"billing_state":"EE-37"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

```Ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://igw-demo.every-pay.com/api/v4/payments/credit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic REPLACE_BASIC_AUTH'
request["content-type"] = 'application/json'
request.body = "{\"account_name\":\"EUR3D1\",\"nonce\":\"165784ab51fkm\",\"timestamp\":\"2023-12-05T10:27:32Z\",\"amount\":0.05,\"order_reference\":\"84005a6c\",\"email\":\"example@gmail.com\",\"customer_url\":\"https://example.com\",\"api_username\":\"a04e7ce1060e7024\",\"billing_city\":\"Tallinn\",\"billing_country\":\"EE\",\"billing_line1\":\"Tartu mnt 2\",\"billing_line2\":null,\"billing_line3\":null,\"billing_postcode\":10145,\"billing_state\":\"EE-37\"}"

response = http.request(request)
puts response.read_body
```

```PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "https://igw-demo.every-pay.com/api/v4/payments/credit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{"account_name":"EUR3D1","nonce":"165784ab51fkm","timestamp":"2023-12-05T10:27:32Z","amount":0.05,"order_reference":"84005a6c","email":"example@gmail.com","customer_url":"https://example.com","api_username":"a04e7ce1060e7024","billing_city":"Tallinn","billing_country":"EE","billing_line1":"Tartu mnt 2","billing_line2":null,"billing_line3":null,"billing_postcode":10145,"billing_state":"EE-37"}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic REPLACE_BASIC_AUTH",
    "content-type: application/json"
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

```Shell
curl --request POST \
  --url https://igw-demo.every-pay.com/api/v4/payments/credit \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json' \
  --data '{"account_name":"EUR3D1","nonce":"165784ab51fkm","timestamp":"2023-12-05T10:27:32Z","amount":0.05,"order_reference":"84005a6c","email":"example@gmail.com","customer_url":"https://example.com","api_username":"a04e7ce1060e7024","billing_city":"Tallinn","billing_country":"EE","billing_line1":"Tartu mnt 2","billing_line2":null,"billing_line3":null,"billing_postcode":10145,"billing_state":"EE-37"}'
```

--------------------------------

### GET /v4/processing_accounts

Source: https://support.every-pay.com/apidoc/main/#section/EveryPay-API

Retrieve a detailed list of all available processing accounts and payment methods for a merchant.

```APIDOC
## GET /v4/processing_accounts

### Description
Retrieve a detailed list of available processing accounts and payment methods associated with the merchant.

### Method
GET

### Endpoint
https://igw-demo.every-pay.com/api/v4/processing_accounts

### Parameters
#### Query Parameters
- **api_username** (string) - Required - The api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header (16 characters).

### Request Example
```
GET /api/v4/processing_accounts?api_username=a04e7ce1060e7024
```

### Response
#### Success Response (200)
- **id** (integer) - Account ID
- **url** (string) - Account URL
- **descriptor** (string) - Account descriptor
- **mcc** (string) - Merchant Category Code
- **api_username** (string) - API username
- **processing_accounts** (array) - List of processing accounts

#### Response Example
{
  "id": 5712,
  "url": "https://example.com",
  "descriptor": "example.com",
  "mcc": "5999",
  "api_username": "a04e7ce1060e7024",
  "processing_accounts": [
    {
      "account_name": "EUR3D1",
      "pre_authorisation": false,
      "currency": "EUR",
      "support_3ds": true,
      "capture_delay_days": 0
    }
  ]
}
```
Tokens:
Raw