Open a hosted checkout from a launch link

curl --request GET \
  --url https://apistagepc.grogov.us/api/v1/payer/intake/link

const options = {method: 'GET'};

fetch('https://apistagepc.grogov.us/api/v1/payer/intake/link', 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://apistagepc.grogov.us/api/v1/payer/intake/link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://apistagepc.grogov.us/api/v1/payer/intake/link"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apistagepc.grogov.us/api/v1/payer/intake/link")

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

request = Net::HTTP::Get.new(url)

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

Hosted checkout

Open a hosted checkout from a launch link

A launch link carries the checkout in its query string, so you can put it in an email, a button, or an iframe src. Every time the link is opened it creates a new checkout and redirects to it, so one link can be reused. Anyone holding the link can start a checkout with it.

It takes the same fields as POST /api/v1/payer/intake except metadata and the items’ required and metadata. Number the items from 1: item1_id, item1_description, item1_amount, item1_quantity, item1_category, then item2_…. Bracket names such as items[0][id] also work, and amount_cents is accepted for amount. For a single item you can send description and amount, with optional item_id (default ITEM-001) and quantity.

GET

api

payer

intake

link

Open a hosted checkout from a launch link

curl --request GET \
  --url https://apistagepc.grogov.us/api/v1/payer/intake/link

const options = {method: 'GET'};

fetch('https://apistagepc.grogov.us/api/v1/payer/intake/link', 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://apistagepc.grogov.us/api/v1/payer/intake/link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://apistagepc.grogov.us/api/v1/payer/intake/link"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apistagepc.grogov.us/api/v1/payer/intake/link")

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

request = Net::HTTP::Get.new(url)

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

Query Parameters

portal_id

string<uuid>

required

reference_id

string

required

Maximum string length: 64

label

string

Maximum string length: 80

payer_name

string

Maximum string length: 200

payer_email

string<email>

payer_phone

string

Maximum string length: 50

return_url

string<uri>

cancel_url

string<uri>

expires_at

string<date-time>

item1_id

string

First item. Repeat the itemN_ fields for each further item. item1_id, item1_description and item1_amount are required unless you send a single item with description and amount.

Maximum string length: 64

item1_description

string

Maximum string length: 200

item1_amount

integer

Price of one unit, in cents

Required range: x >= 0

item1_quantity

integer

default:1

Required range: x >= 1

item1_category

string

Maximum string length: 32

description

string

Single-item form: the item's description. Ignored when any itemN_ or items[…] field is present.

Maximum string length: 200

amount

integer

Single-item form: price of one unit, in cents. amount_cents is accepted too.

Required range: x >= 0

item_id

string

default:ITEM-001

Single-item form: the item's id.

Maximum string length: 64

quantity

integer

default:1

Single-item form: the quantity.

Required range: x >= 1

embed

enum<string>

Send iframe when the link is the src of an iframe, so the checkout renders for embedding.

Available options:

iframe

Response

303

Always a redirect, as for POST /api/v1/payer/intake.

Auth

Vault

Payments

Hosted checkout

API Reference

Open a hosted checkout from a launch link

Query Parameters

Response