Initialize recurring

POST

payments

recurring

init

{terminal_friendly_id}

cURL

curl --request POST \
  --url https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 500000,
  "recurring": {
    "first_payment_date": "<string>",
    "time_interval": 2,
    "number_of_payments": 2,
    "cancellation_date": "<string>"
  },
  "payer_fingerprint": "<string>",
  "token": "<string>",
  "provider_token": "<string>",
  "cvv": "<string>",
  "payment_collection": "hosted_page"
}
'

import requests

url = "https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}"

payload = {
    "amount": 500000,
    "recurring": {
        "first_payment_date": "<string>",
        "time_interval": 2,
        "number_of_payments": 2,
        "cancellation_date": "<string>"
    },
    "payer_fingerprint": "<string>",
    "token": "<string>",
    "provider_token": "<string>",
    "cvv": "<string>",
    "payment_collection": "hosted_page"
}
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({
    amount: 500000,
    recurring: {
      first_payment_date: '<string>',
      time_interval: 2,
      number_of_payments: 2,
      cancellation_date: '<string>'
    },
    payer_fingerprint: '<string>',
    token: '<string>',
    provider_token: '<string>',
    cvv: '<string>',
    payment_collection: 'hosted_page'
  })
};

fetch('https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}', 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://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}",
  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([
    'amount' => 500000,
    'recurring' => [
        'first_payment_date' => '<string>',
        'time_interval' => 2,
        'number_of_payments' => 2,
        'cancellation_date' => '<string>'
    ],
    'payer_fingerprint' => '<string>',
    'token' => '<string>',
    'provider_token' => '<string>',
    'cvv' => '<string>',
    'payment_collection' => 'hosted_page'
  ]),
  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://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}"

	payload := strings.NewReader("{\n  \"amount\": 500000,\n  \"recurring\": {\n    \"first_payment_date\": \"<string>\",\n    \"time_interval\": 2,\n    \"number_of_payments\": 2,\n    \"cancellation_date\": \"<string>\"\n  },\n  \"payer_fingerprint\": \"<string>\",\n  \"token\": \"<string>\",\n  \"provider_token\": \"<string>\",\n  \"cvv\": \"<string>\",\n  \"payment_collection\": \"hosted_page\"\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://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 500000,\n  \"recurring\": {\n    \"first_payment_date\": \"<string>\",\n    \"time_interval\": 2,\n    \"number_of_payments\": 2,\n    \"cancellation_date\": \"<string>\"\n  },\n  \"payer_fingerprint\": \"<string>\",\n  \"token\": \"<string>\",\n  \"provider_token\": \"<string>\",\n  \"cvv\": \"<string>\",\n  \"payment_collection\": \"hosted_page\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}")

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  \"amount\": 500000,\n  \"recurring\": {\n    \"first_payment_date\": \"<string>\",\n    \"time_interval\": 2,\n    \"number_of_payments\": 2,\n    \"cancellation_date\": \"<string>\"\n  },\n  \"payer_fingerprint\": \"<string>\",\n  \"token\": \"<string>\",\n  \"provider_token\": \"<string>\",\n  \"cvv\": \"<string>\",\n  \"payment_collection\": \"hosted_page\"\n}"

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

{
  "transaction_id": "<string>",
  "recurring_id": "<string>",
  "accepted": true,
  "order_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

Initializing recurring billing creates a series and submits its first transaction for processing. Save the returned recurring_id for later recurring and future-transaction operations.

Retry a previous initialization

Use this same endpoint to create a new retry attempt. In the request body, provide retry.originating_id for the previous SmartRetry recurring initialization transaction.

A retry request creates a new attempt. To safely replay the exact same request after an ambiguous failure, reuse its Idempotency-Key. See Idempotency.

Authorizations

x-api-key

string

header

required

Headers

idempotency-key

string

Optional idempotency key, scoped to terminal + matched route pattern. A replayed request returns the cached response with Idempotency-Replayed: true.

Maximum string length: 255

Pattern: ^[\w-]+$

Path Parameters

terminal_friendly_id

string

required

The unique identifier of the terminal.

Required string length: 6

Pattern: ^[\dA-Za-z]{6}$

Body

application/json

Option 1
Option 2

Exactly one of token, provider_token, or payment_instrument must be supplied, unless payment_collection is hosted_page.

amount

number

required

Payment amount in major currency units (e.g. 10.00 for $10.00 USD).

Required range: 0.01 <= x <= 999999.99

currency

enum<string>

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BOV,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLF,

CLP,

CNY,

COP,

COU,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MXV,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

USN,

UYI,

UYU,

UYW,

UZS,

VED,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

XSU,

XTS,

XUA,

XXX,

YER,

ZAR,

ZMW,

ZWL

recurring

object

required

Show child attributes

payment_instrument

object

Show child attributes

payer

object

Show child attributes

payer_fingerprint

string

Pre-computed payer fingerprint from an existing transaction. Mutually exclusive with payer.

Minimum string length: 88

token

string

A stored payment token from the merchant's Payment Instruments.

Required string length: 88

provider_token

string

A tokenized payment method reference issued directly by the payment provider (e.g. a Stripe payment_method or Adyen storedPaymentMethodId), forwarded to the processor as-is. Distinct from token, which is a SmartRetry Payment Instrument token.

Required string length: 1 - 255

cvv

string

CVV/CVC of the card. Optional for added security (cannot be stored).

Required string length: 3 - 4

Pattern: ^[0-9]{3,4}$

payment_collection

enum<string>

Available options:

hosted_page

Response

Default Response

transaction_id

string

required

Required string length: 8

Pattern: ^[\dA-Za-z]{8}$

recurring_id

string

required

Required string length: 8

Pattern: ^[\dA-Za-z]{8}$

accepted

boolean

required

order_id

string

required

Required string length: 8

Pattern: ^[\dA-Za-z]{8}$

cURL

curl --request POST \
  --url https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 500000,
  "recurring": {
    "first_payment_date": "<string>",
    "time_interval": 2,
    "number_of_payments": 2,
    "cancellation_date": "<string>"
  },
  "payer_fingerprint": "<string>",
  "token": "<string>",
  "provider_token": "<string>",
  "cvv": "<string>",
  "payment_collection": "hosted_page"
}
'

import requests

url = "https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}"

payload = {
    "amount": 500000,
    "recurring": {
        "first_payment_date": "<string>",
        "time_interval": 2,
        "number_of_payments": 2,
        "cancellation_date": "<string>"
    },
    "payer_fingerprint": "<string>",
    "token": "<string>",
    "provider_token": "<string>",
    "cvv": "<string>",
    "payment_collection": "hosted_page"
}
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({
    amount: 500000,
    recurring: {
      first_payment_date: '<string>',
      time_interval: 2,
      number_of_payments: 2,
      cancellation_date: '<string>'
    },
    payer_fingerprint: '<string>',
    token: '<string>',
    provider_token: '<string>',
    cvv: '<string>',
    payment_collection: 'hosted_page'
  })
};

fetch('https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}', 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://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}",
  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([
    'amount' => 500000,
    'recurring' => [
        'first_payment_date' => '<string>',
        'time_interval' => 2,
        'number_of_payments' => 2,
        'cancellation_date' => '<string>'
    ],
    'payer_fingerprint' => '<string>',
    'token' => '<string>',
    'provider_token' => '<string>',
    'cvv' => '<string>',
    'payment_collection' => 'hosted_page'
  ]),
  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://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}"

	payload := strings.NewReader("{\n  \"amount\": 500000,\n  \"recurring\": {\n    \"first_payment_date\": \"<string>\",\n    \"time_interval\": 2,\n    \"number_of_payments\": 2,\n    \"cancellation_date\": \"<string>\"\n  },\n  \"payer_fingerprint\": \"<string>\",\n  \"token\": \"<string>\",\n  \"provider_token\": \"<string>\",\n  \"cvv\": \"<string>\",\n  \"payment_collection\": \"hosted_page\"\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://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 500000,\n  \"recurring\": {\n    \"first_payment_date\": \"<string>\",\n    \"time_interval\": 2,\n    \"number_of_payments\": 2,\n    \"cancellation_date\": \"<string>\"\n  },\n  \"payer_fingerprint\": \"<string>\",\n  \"token\": \"<string>\",\n  \"provider_token\": \"<string>\",\n  \"cvv\": \"<string>\",\n  \"payment_collection\": \"hosted_page\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://terminal.smartretry.com/v1/payments/recurring/init/{terminal_friendly_id}")

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  \"amount\": 500000,\n  \"recurring\": {\n    \"first_payment_date\": \"<string>\",\n    \"time_interval\": 2,\n    \"number_of_payments\": 2,\n    \"cancellation_date\": \"<string>\"\n  },\n  \"payer_fingerprint\": \"<string>\",\n  \"token\": \"<string>\",\n  \"provider_token\": \"<string>\",\n  \"cvv\": \"<string>\",\n  \"payment_collection\": \"hosted_page\"\n}"

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

{
  "transaction_id": "<string>",
  "recurring_id": "<string>",
  "accepted": true,
  "order_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "reason_code": "<string>",
  "instance": "<string>",
  "context": {}
}

Overview

Payments

Recurring

Future Transactions

Retry a previous initialization

Authorizations

Headers

Path Parameters

Body

Response

​Retry a previous initialization

Authorizations

Headers

Path Parameters

Body

Response

Retry a previous initialization