Quick Start
Let's get you set up and ready to start using the Payment API
Use your Client credentials
Let's make sure you can gain access to our Payment API. As an API Partner you will be set up with secure credentials to gain access and authenticate your requests. Use your FrontStream assigned ClientId and ClientSecret to retrieve a one time use AccessToken for gaining access to our different API endpoints.
Missing your credentials? Please contact us at:
To try a test and directly interact with the API endpoint click "Test It" and use an embedded API client to send requests with custom headers and variables, then see the live response; essentially letting you test this API directly within this page. When testing please use our Demo URL: https://demo-payments.frontstream.com/api/ClientSession
Return HTTP Status Code 200 (OK) with AccessToken Returns HTTP Status Code 400 if could not authenticate
Unique identifier for the API Partner; provided by FrontStream
Key specifically paired to the clientId
POST /api/ClientSession HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 41
{
"ClientId": "text",
"ClientSecret": "text"
}
{
"Token": "text",
"ClientId": "123e4567-e89b-12d3-a456-426614174000",
"ExpirationDate": "2025-07-05T17:48:22.461Z"
}
Client Session Example
Take a look at how you might call this method:
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
public class Program
{
public static async Task Main(string[] args)
{
using (var client = new HttpClient())
{
var url = "/api/ClientSession";
var requestBody = new
{
ClientId = "text",
ClientSecret = "text"
};
var content = new StringContent(
Newtonsoft.Json.JsonConvert.SerializeObject(requestBody),
Encoding.UTF8,
"application/json-patch+json"
);
var response = await client.PostAsync(url, content);
var responseData = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseData);
}
}
}
For more information please contact us at:
Ready to make your first Payment request?
API referencesLast updated