Skip to main content
POST
/
api
/
v1
/
sessions
/
point-in-time
/
plugin
Create Session
curl --request POST \
  --url https://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_unique_id1": "70646041-01ea-4cd6-b657-18ff88e465c7",
  "host_uri": "https://digitalpay-test.ingo.money",
  "language_locale_code": "en-US",
  "recipient_information": {
    "first_name": "Alex",
    "last_name": "Rivera",
    "business_name": "Acme Limited",
    "address_line1": "100 Innovation Way",
    "city": "Anytown",
    "state": "GA",
    "zip_code": "37233",
    "email_address": "jack.frost@example.com",
    "phone_number": "1231231234",
    "mobile_number": "1231231234",
    "open_banking": {
      "mobus_customer_id": "9999"
    }
  }
}
'
import requests

url = "https://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin"

payload = {
    "participant_unique_id1": "70646041-01ea-4cd6-b657-18ff88e465c7",
    "host_uri": "https://digitalpay-test.ingo.money",
    "language_locale_code": "en-US",
    "recipient_information": {
        "first_name": "Alex",
        "last_name": "Rivera",
        "business_name": "Acme Limited",
        "address_line1": "100 Innovation Way",
        "city": "Anytown",
        "state": "GA",
        "zip_code": "37233",
        "email_address": "jack.frost@example.com",
        "phone_number": "1231231234",
        "mobile_number": "1231231234",
        "open_banking": { "mobus_customer_id": "9999" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    participant_unique_id1: '70646041-01ea-4cd6-b657-18ff88e465c7',
    host_uri: 'https://digitalpay-test.ingo.money',
    language_locale_code: 'en-US',
    recipient_information: {
      first_name: 'Alex',
      last_name: 'Rivera',
      business_name: 'Acme Limited',
      address_line1: '100 Innovation Way',
      city: 'Anytown',
      state: 'GA',
      zip_code: '37233',
      email_address: 'jack.frost@example.com',
      phone_number: '1231231234',
      mobile_number: '1231231234',
      open_banking: {mobus_customer_id: '9999'}
    }
  })
};

fetch('https://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin', 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://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin",
  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([
    'participant_unique_id1' => '70646041-01ea-4cd6-b657-18ff88e465c7',
    'host_uri' => 'https://digitalpay-test.ingo.money',
    'language_locale_code' => 'en-US',
    'recipient_information' => [
        'first_name' => 'Alex',
        'last_name' => 'Rivera',
        'business_name' => 'Acme Limited',
        'address_line1' => '100 Innovation Way',
        'city' => 'Anytown',
        'state' => 'GA',
        'zip_code' => '37233',
        'email_address' => 'jack.frost@example.com',
        'phone_number' => '1231231234',
        'mobile_number' => '1231231234',
        'open_banking' => [
                'mobus_customer_id' => '9999'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin"

	payload := strings.NewReader("{\n  \"participant_unique_id1\": \"70646041-01ea-4cd6-b657-18ff88e465c7\",\n  \"host_uri\": \"https://digitalpay-test.ingo.money\",\n  \"language_locale_code\": \"en-US\",\n  \"recipient_information\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Rivera\",\n    \"business_name\": \"Acme Limited\",\n    \"address_line1\": \"100 Innovation Way\",\n    \"city\": \"Anytown\",\n    \"state\": \"GA\",\n    \"zip_code\": \"37233\",\n    \"email_address\": \"jack.frost@example.com\",\n    \"phone_number\": \"1231231234\",\n    \"mobile_number\": \"1231231234\",\n    \"open_banking\": {\n      \"mobus_customer_id\": \"9999\"\n    }\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"participant_unique_id1\": \"70646041-01ea-4cd6-b657-18ff88e465c7\",\n  \"host_uri\": \"https://digitalpay-test.ingo.money\",\n  \"language_locale_code\": \"en-US\",\n  \"recipient_information\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Rivera\",\n    \"business_name\": \"Acme Limited\",\n    \"address_line1\": \"100 Innovation Way\",\n    \"city\": \"Anytown\",\n    \"state\": \"GA\",\n    \"zip_code\": \"37233\",\n    \"email_address\": \"jack.frost@example.com\",\n    \"phone_number\": \"1231231234\",\n    \"mobile_number\": \"1231231234\",\n    \"open_banking\": {\n      \"mobus_customer_id\": \"9999\"\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://iip-session-management-uat.ingo.money/api/v1/sessions/point-in-time/plugin")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"participant_unique_id1\": \"70646041-01ea-4cd6-b657-18ff88e465c7\",\n  \"host_uri\": \"https://digitalpay-test.ingo.money\",\n  \"language_locale_code\": \"en-US\",\n  \"recipient_information\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Rivera\",\n    \"business_name\": \"Acme Limited\",\n    \"address_line1\": \"100 Innovation Way\",\n    \"city\": \"Anytown\",\n    \"state\": \"GA\",\n    \"zip_code\": \"37233\",\n    \"email_address\": \"jack.frost@example.com\",\n    \"phone_number\": \"1231231234\",\n    \"mobile_number\": \"1231231234\",\n    \"open_banking\": {\n      \"mobus_customer_id\": \"9999\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "status": 100,
  "client_message": "Success",
  "data": {
    "session_identifier": "7830227a-ba47-4d28-9416-cad41a446db7",
    "authorized_url": "https://iip-webplugin-ingo.money/session/7830227a-ba47-4d28-9416-cad41a446db7?t=637126733246949906&h=rpSb%2f%2fAeOAKjX7%2fhhOQvj9zpvwf4xeg97TuPCMtpUg0%3d",
    "authorized_url_expiration_utc": "2019-12-10T20:14:19.763941Z",
    "participant_unique_id1": "1f271ff6-5b79-45b6-a71e-aa9d1b86c0d8",
    "participant_unique_id2": ""
  },
  "time": 0.8
}

Headers

​
Idempotency-Key
string

Unique client-generated key (V4 UUID recommended) for safely retrying a session request without creating a duplicate session. Keys remain active for 2 hours. A status 101 response is returned when the same key is reused within that window.

Maximum string length: 250
Example:

"3f2a1b4c-9d8e-7f6a-5b4c-3d2e1f0a9b8c"

Body

application/json
​
participant_unique_id1
string
required

Participant-assigned ID for the session request. Carry this value forward to subsequent process requests for tracking.

Maximum string length: 100
Example:

"70646041-01ea-4cd6-b657-18ff88e465c7"

​
recipient_information
object
required

Client-provided recipient verification information.

​
participant_unique_id2
string

Optional second participant-assigned ID. Can also be carried forward to process requests for tracking.

Maximum string length: 100
Example:

"DEF-5678"

​
host_uri
string

URI of the hosting application (include protocol and hostname, e.g. https://digitalpay.ingo.money). Must be explicitly whitelisted in client configuration. Defaults to the first configured parent application host domain if omitted.

Maximum string length: 200
Example:

"https://digitalpay.ingo.money"

​
language_locale_code
enum<string>

IETF locale code specifying the language to use when launching the iFrame.

Available options:
ar-SA,
cs-CZ,
da-DK,
de-DE,
en-GB,
en-US,
es-ES,
es-US,
fa-IR,
fi-FI,
fr-FR,
hmn-Latn,
it-IT,
ja-JP,
km-KH,
ko-KR,
nb-NO,
nl-NL,
pl-PL,
pt-BR,
ru-RU,
sv-SE,
tl-PH,
tr-TR,
vi-VN,
zh-CN,
zh-Hans,
zh-TW
Maximum string length: 5
Example:

"en-US"

Response

Session created successfully, or idempotent response returned.

​
status
integer

Numeric status code. 100 = Success; 101 = Success (Idempotent — existing session returned, no new session created).

Example:

100

​
client_message
string

Human-readable description of the status code.

Example:

"Success"

​
data
object

Session identifiers and authorized launch URL.

​
time
number

Server-side request processing time in seconds.

Example:

0.8