Exchange an authorization code for a grant token

POST

connect

token

curl --request POST \
  --url https://api.paygent.payman.ai/connect/token \
  --header 'Content-Type: application/json' \
  --header 'x-paygent-connect-app-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "redirectUri": "<string>"
}
'

import requests

url = "https://api.paygent.payman.ai/connect/token"

payload = {
    "code": "<string>",
    "redirectUri": "<string>"
}
headers = {
    "x-paygent-connect-app-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-paygent-connect-app-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>', redirectUri: '<string>'})
};

fetch('https://api.paygent.payman.ai/connect/token', 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.paygent.payman.ai/connect/token",
  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([
    'code' => '<string>',
    'redirectUri' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-paygent-connect-app-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://api.paygent.payman.ai/connect/token"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"redirectUri\": \"<string>\"\n}")

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

	req.Header.Add("x-paygent-connect-app-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://api.paygent.payman.ai/connect/token")
  .header("x-paygent-connect-app-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"redirectUri\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygent.payman.ai/connect/token")

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

request = Net::HTTP::Post.new(url)
request["x-paygent-connect-app-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"redirectUri\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "appId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scopes": [
    "<string>"
  ],
  "grantTokenMasked": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "grantToken": "<string>",
  "environment": "sandbox",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z"
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

Authorizations

x-paygent-connect-app-key

string

header

required

A Connect app key (pgc_app_…), identifying the registered third-party app. Always presented together with connectGrant — the pair is one credential, and either half alone is refused. Accepted on the /connect/* surface only.

Body

application/json

code

string

required

Maximum string length: 256

redirectUri

string

required

The same URI the code was issued for. Compared byte for byte.

Maximum string length: 2048

Response

The grant. Its token is on this response only.

string<uuid>

required

appId

string<uuid>

required

deploymentId

string<uuid>

required

scopes

string[]

required

Checked on every Connect route, even while there is only one.

grantTokenMasked

string

required

Enough to recognise the token, never enough to use it.

createdAt

string<date-time>

required

expiresAt

string<date-time>

required

Grants age out at ninety days, like every other credential here.

grantToken

string

required

The plaintext pgc_grant_… token, on this response only. Present it together with the app key on every Connect call.

environment

enum<string>

required

The app's world, restated where the credential is handed over so an integration can assert it is holding the kind of key it thinks it is. Here and not on the base grant shape: the consumer console's grant lists have no use for it.

Available options:

sandbox,

live

lastUsedAt

string<date-time> | null

revokedAt

string<date-time> | null

⌘I

Exchange an authorization code for a grant token

curl --request POST \
  --url https://api.paygent.payman.ai/connect/token \
  --header 'Content-Type: application/json' \
  --header 'x-paygent-connect-app-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "redirectUri": "<string>"
}
'

import requests

url = "https://api.paygent.payman.ai/connect/token"

payload = {
    "code": "<string>",
    "redirectUri": "<string>"
}
headers = {
    "x-paygent-connect-app-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-paygent-connect-app-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>', redirectUri: '<string>'})
};

fetch('https://api.paygent.payman.ai/connect/token', 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.paygent.payman.ai/connect/token",
  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([
    'code' => '<string>',
    'redirectUri' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-paygent-connect-app-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://api.paygent.payman.ai/connect/token"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"redirectUri\": \"<string>\"\n}")

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

	req.Header.Add("x-paygent-connect-app-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://api.paygent.payman.ai/connect/token")
  .header("x-paygent-connect-app-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"redirectUri\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygent.payman.ai/connect/token")

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

request = Net::HTTP::Post.new(url)
request["x-paygent-connect-app-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"redirectUri\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "appId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scopes": [
    "<string>"
  ],
  "grantTokenMasked": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "grantToken": "<string>",
  "environment": "sandbox",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z"
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

Connect

Act

Approve

Tool

Exchange an authorization code for a grant token

Authorizations

Body

Response