Public

Start bank redirect for an existing sponsorship order

Public, throttled to 30 requests per minute. Requires a live Redis cart; prices an immutable snapshot of its selected recipients/designations and frequencies, including any configured fee consent. signup requires unique signup_username (min 5), unique valid email and required public donor identity/custom profile fields. login requires a donor linked to the checkout session and a verified session compatible with the saved Stripe customer. Recurring orders require recurring bank support. No donation is recorded until bank confirmation; use returned program_id/token to complete or cancel. A supplied stale donor-form policy_revision returns 409.

POST

frontend

checkout

order-ideal

{client_id}

{program_id}

{session_id}

Start bank redirect for an existing sponsorship order

curl --request POST \
  --url https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_path": "/donate/return",
  "first_name": "<string>",
  "last_name": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "street": "<string>",
  "street2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "organization_name": "<string>",
  "signup_username": "<string>",
  "policy_revision": "<string>",
  "type": "INDIVIDUAL",
  "email": "jsmith@example.com",
  "custom_fields": {},
  "check_number": "<string>",
  "next": "2023-12-25",
  "confirmation_token": "ctoken_example123"
}
'

import requests

url = "https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}"

payload = {
    "return_path": "/donate/return",
    "first_name": "<string>",
    "last_name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "organization_name": "<string>",
    "signup_username": "<string>",
    "policy_revision": "<string>",
    "type": "INDIVIDUAL",
    "email": "jsmith@example.com",
    "custom_fields": {},
    "check_number": "<string>",
    "next": "2023-12-25",
    "confirmation_token": "ctoken_example123"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    return_path: '/donate/return',
    first_name: '<string>',
    last_name: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    phone: '<string>',
    street: '<string>',
    street2: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    country: '<string>',
    organization_name: '<string>',
    signup_username: '<string>',
    policy_revision: '<string>',
    type: 'INDIVIDUAL',
    email: 'jsmith@example.com',
    custom_fields: {},
    check_number: '<string>',
    next: '2023-12-25',
    confirmation_token: 'ctoken_example123'
  })
};

fetch('https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_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://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_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([
    'return_path' => '/donate/return',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'phone' => '<string>',
    'street' => '<string>',
    'street2' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'organization_name' => '<string>',
    'signup_username' => '<string>',
    'policy_revision' => '<string>',
    'type' => 'INDIVIDUAL',
    'email' => 'jsmith@example.com',
    'custom_fields' => [
        
    ],
    'check_number' => '<string>',
    'next' => '2023-12-25',
    'confirmation_token' => 'ctoken_example123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}"

	payload := strings.NewReader("{\n  \"return_path\": \"/donate/return\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"street\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"organization_name\": \"<string>\",\n  \"signup_username\": \"<string>\",\n  \"policy_revision\": \"<string>\",\n  \"type\": \"INDIVIDUAL\",\n  \"email\": \"jsmith@example.com\",\n  \"custom_fields\": {},\n  \"check_number\": \"<string>\",\n  \"next\": \"2023-12-25\",\n  \"confirmation_token\": \"ctoken_example123\"\n}")

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

	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.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"return_path\": \"/donate/return\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"street\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"organization_name\": \"<string>\",\n  \"signup_username\": \"<string>\",\n  \"policy_revision\": \"<string>\",\n  \"type\": \"INDIVIDUAL\",\n  \"email\": \"jsmith@example.com\",\n  \"custom_fields\": {},\n  \"check_number\": \"<string>\",\n  \"next\": \"2023-12-25\",\n  \"confirmation_token\": \"ctoken_example123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"return_path\": \"/donate/return\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"street\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"organization_name\": \"<string>\",\n  \"signup_username\": \"<string>\",\n  \"policy_revision\": \"<string>\",\n  \"type\": \"INDIVIDUAL\",\n  \"email\": \"jsmith@example.com\",\n  \"custom_fields\": {},\n  \"check_number\": \"<string>\",\n  \"next\": \"2023-12-25\",\n  \"confirmation_token\": \"ctoken_example123\"\n}"

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

{
  "status": "redirect",
  "checkout_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "checkout_secret": "<string>",
  "redirect_url": "<string>",
  "program_id": 123
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Path Parameters

client_id

integer

required

Client id.

Required range: x >= 1

Example:

207

program_id

string

required

Program id. Program route; order/cart methods may accept hyphen-separated program IDs.

Example:

"11"

session_id

string

required

Session id. Frontend or recipient session ID belonging to this organization.

Example:

"checkout-session-from-response"

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

return_path

string

required

Required app-relative return path: starts with one slash, never //, and contains no backslash.

Required string length: 1 - 2000

Pattern: ^/(?!/)[^\\\\]*$

Example:

"/donate/return"

checkout_mode

enum<string>

required

signup requires a new donor identity and username; login reuses the donor linked to this checkout session.

Available options:

signup,

login

first_name

string

last_name

string

firstName

string

lastName

string

phone

string

street

string

street2

string

city

string

state

string

zip

string

country

string

organization_name

string

Maximum string length: 255

Required and unique within the organization when checkout_mode=signup.

Minimum string length: 5

policy_revision

string

type

enum<string>

default:INDIVIDUAL

Organization identity requires organization_name (max 255). Missing type normalizes to INDIVIDUAL.

Available options:

INDIVIDUAL,

ORGANIZATION

string<email>

Required for campaign and new signup checkout. Existing donor email requires a verified checkout session before payment.

custom_fields

object | null

Public donation-field map, at most 100 keys, admitted by donation_field_checkout_v1 and currently visible definitions. Required public fields and select choices are enforced; hidden conditional children are excluded. Text is at most 5000 characters; date values use Y-m-d, numbers are numeric. With the rollout disabled, this map must be empty.

Show child attributes

check_number

string | null

Maximum string length: 100

string<date>

Optional recurring start date; a valid future date creates a setup-only bank confirmation.

confirmation_token

string | null

Optional Stripe native iDEAL confirmation token for this checkout processor.

Maximum string length: 255

Pattern: ^ctoken_[A-Za-z0-9]+$

Example:

"ctoken_example123"

Response

Start bank redirect for an existing sponsorship order response.

status

enum<string>

Available options:

redirect

checkout_token

string<uuid>

checkout_secret

string

Browser possession secret for disclosing the full result; retain alongside the checkout token.

redirect_url

string<uri> | null

Provider bank redirect, possibly null when already confirmed or no next action is required.

program_id

integer

Present for order checkout. Use this anchor ID when completing/canceling an order with a composite program route.

Start bank redirect for an existing sponsorship order

curl --request POST \
  --url https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_path": "/donate/return",
  "first_name": "<string>",
  "last_name": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "street": "<string>",
  "street2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "organization_name": "<string>",
  "signup_username": "<string>",
  "policy_revision": "<string>",
  "type": "INDIVIDUAL",
  "email": "jsmith@example.com",
  "custom_fields": {},
  "check_number": "<string>",
  "next": "2023-12-25",
  "confirmation_token": "ctoken_example123"
}
'

import requests

url = "https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}"

payload = {
    "return_path": "/donate/return",
    "first_name": "<string>",
    "last_name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "organization_name": "<string>",
    "signup_username": "<string>",
    "policy_revision": "<string>",
    "type": "INDIVIDUAL",
    "email": "jsmith@example.com",
    "custom_fields": {},
    "check_number": "<string>",
    "next": "2023-12-25",
    "confirmation_token": "ctoken_example123"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    return_path: '/donate/return',
    first_name: '<string>',
    last_name: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    phone: '<string>',
    street: '<string>',
    street2: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    country: '<string>',
    organization_name: '<string>',
    signup_username: '<string>',
    policy_revision: '<string>',
    type: 'INDIVIDUAL',
    email: 'jsmith@example.com',
    custom_fields: {},
    check_number: '<string>',
    next: '2023-12-25',
    confirmation_token: 'ctoken_example123'
  })
};

fetch('https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_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://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_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([
    'return_path' => '/donate/return',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'phone' => '<string>',
    'street' => '<string>',
    'street2' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'organization_name' => '<string>',
    'signup_username' => '<string>',
    'policy_revision' => '<string>',
    'type' => 'INDIVIDUAL',
    'email' => 'jsmith@example.com',
    'custom_fields' => [
        
    ],
    'check_number' => '<string>',
    'next' => '2023-12-25',
    'confirmation_token' => 'ctoken_example123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}"

	payload := strings.NewReader("{\n  \"return_path\": \"/donate/return\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"street\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"organization_name\": \"<string>\",\n  \"signup_username\": \"<string>\",\n  \"policy_revision\": \"<string>\",\n  \"type\": \"INDIVIDUAL\",\n  \"email\": \"jsmith@example.com\",\n  \"custom_fields\": {},\n  \"check_number\": \"<string>\",\n  \"next\": \"2023-12-25\",\n  \"confirmation_token\": \"ctoken_example123\"\n}")

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

	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.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"return_path\": \"/donate/return\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"street\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"organization_name\": \"<string>\",\n  \"signup_username\": \"<string>\",\n  \"policy_revision\": \"<string>\",\n  \"type\": \"INDIVIDUAL\",\n  \"email\": \"jsmith@example.com\",\n  \"custom_fields\": {},\n  \"check_number\": \"<string>\",\n  \"next\": \"2023-12-25\",\n  \"confirmation_token\": \"ctoken_example123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"return_path\": \"/donate/return\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"street\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"organization_name\": \"<string>\",\n  \"signup_username\": \"<string>\",\n  \"policy_revision\": \"<string>\",\n  \"type\": \"INDIVIDUAL\",\n  \"email\": \"jsmith@example.com\",\n  \"custom_fields\": {},\n  \"check_number\": \"<string>\",\n  \"next\": \"2023-12-25\",\n  \"confirmation_token\": \"ctoken_example123\"\n}"

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

{
  "status": "redirect",
  "checkout_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "checkout_secret": "<string>",
  "redirect_url": "<string>",
  "program_id": 123
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}