Content
Retrieve the full client content configuration bundle (e.g. app strings, feature flags, and branding assets) as a JSON object.
GET /v1/content
Auth: Access token (Bearer).
Responses
| Status | Description |
|---|---|
200 | The client content was retrieved successfully. |
400 | The request failed validation, the error object will contain further information. |
422 | The request payload is invalid, the error object will contain further information. |
429 | Too many requests are being sent concurrently or rate limiting has taken effect. |
500 | An unexpected error occurred, the error object will contain further information. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | No | Gets a value indicating whether the operation was successful. |
json
{
"success": true
}Code samples
ts
// @vantagepay/vantagepay
const content = await client.content.getClientContent()csharp
// VantagePay.SDK
// Retrieves client content. Not wrapped by the .NET SDK.
// Not wrapped by the .NET SDK - call the endpoint directly with an authorized HttpClient.
using var http = new HttpClient { BaseAddress = new Uri("https://sandbox-api.vantagepay.dev") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", client.ApiTokens.AccessToken);
var response = await http.GetAsync("/v1/content");
response.EnsureSuccessStatusCode();Retrieve the contact details content (e.g. support email, phone numbers, social links) as a JSON object.
GET /v1/content/contact-details
Auth: Access token (Bearer).
Responses
| Status | Description |
|---|---|
200 | The contact details were retrieved successfully. |
400 | The request failed validation, the error object will contain further information. |
422 | The request payload is invalid, the error object will contain further information. |
429 | Too many requests are being sent concurrently or rate limiting has taken effect. |
500 | An unexpected error occurred, the error object will contain further information. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | No | Gets a value indicating whether the operation was successful. |
json
{
"success": true
}Code samples
ts
// @vantagepay/vantagepay
const contactDetails = await client.content.getContactDetails()csharp
// VantagePay.SDK
// Retrieves support contact details. Not wrapped by the .NET SDK.
// Not wrapped by the .NET SDK - call the endpoint directly with an authorized HttpClient.
using var http = new HttpClient { BaseAddress = new Uri("https://sandbox-api.vantagepay.dev") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", client.ApiTokens.AccessToken);
var response = await http.GetAsync("/v1/content/contact-details");
response.EnsureSuccessStatusCode();Retrieve the privacy policy document in the requested format (JSON, HTML, or Markdown).
GET /v1/content/privacy-policy
Auth: Access token (Bearer).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
format | query | No | The desired output format: json, html, or md. Defaults to JSON when not specified. |
Responses
| Status | Description |
|---|---|
200 | The privacy policy was retrieved successfully. |
400 | The request failed validation, the error object will contain further information. |
422 | The request payload is invalid, the error object will contain further information. |
429 | Too many requests are being sent concurrently or rate limiting has taken effect. |
500 | An unexpected error occurred, the error object will contain further information. |
Code samples
ts
// @vantagepay/vantagepay
// Retrieves the privacy policy content.
// Not wrapped by the JavaScript SDK - call the endpoint directly with the active token.
const response = await fetch(baseUrl + '/v1/content/privacy-policy', {
method: 'GET',
headers: { Authorization: 'Bearer ' + ApiTokens.accessToken },
})
const result = await response.json()csharp
// VantagePay.SDK
// Retrieves the privacy policy content.
// Not wrapped by the .NET SDK - call the endpoint directly with an authorized HttpClient.
using var http = new HttpClient { BaseAddress = new Uri("https://sandbox-api.vantagepay.dev") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", client.ApiTokens.AccessToken);
var response = await http.GetAsync("/v1/content/privacy-policy");
response.EnsureSuccessStatusCode();Retrieve the terms of use document in the requested format (JSON, HTML, or Markdown).
GET /v1/content/terms-of-use
Auth: Access token (Bearer).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
format | query | No | The desired output format: json, html, or md. Defaults to JSON when not specified. |
Responses
| Status | Description |
|---|---|
200 | The terms of use were retrieved successfully. |
400 | The request failed validation, the error object will contain further information. |
422 | The request payload is invalid, the error object will contain further information. |
429 | Too many requests are being sent concurrently or rate limiting has taken effect. |
500 | An unexpected error occurred, the error object will contain further information. |
Code samples
ts
// @vantagepay/vantagepay
// Retrieves the terms-of-use content.
// Not wrapped by the JavaScript SDK - call the endpoint directly with the active token.
const response = await fetch(baseUrl + '/v1/content/terms-of-use', {
method: 'GET',
headers: { Authorization: 'Bearer ' + ApiTokens.accessToken },
})
const result = await response.json()csharp
// VantagePay.SDK
// Retrieves the terms-of-use content.
// Not wrapped by the .NET SDK - call the endpoint directly with an authorized HttpClient.
using var http = new HttpClient { BaseAddress = new Uri("https://sandbox-api.vantagepay.dev") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", client.ApiTokens.AccessToken);
var response = await http.GetAsync("/v1/content/terms-of-use");
response.EnsureSuccessStatusCode();Retrieve the frequently asked questions (FAQ) document in the requested format (JSON, HTML, or Markdown).
GET /v1/content/faq
Auth: Access token (Bearer).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
format | query | No | The desired output format: json, html, or md. Defaults to JSON when not specified. |
Responses
| Status | Description |
|---|---|
200 | The FAQ was retrieved successfully. |
400 | The request failed validation, the error object will contain further information. |
422 | The request payload is invalid, the error object will contain further information. |
429 | Too many requests are being sent concurrently or rate limiting has taken effect. |
500 | An unexpected error occurred, the error object will contain further information. |
Code samples
ts
// @vantagepay/vantagepay
// Retrieves the FAQ content.
// Not wrapped by the JavaScript SDK - call the endpoint directly with the active token.
const response = await fetch(baseUrl + '/v1/content/faq', {
method: 'GET',
headers: { Authorization: 'Bearer ' + ApiTokens.accessToken },
})
const result = await response.json()csharp
// VantagePay.SDK
// Retrieves the FAQ content.
// Not wrapped by the .NET SDK - call the endpoint directly with an authorized HttpClient.
using var http = new HttpClient { BaseAddress = new Uri("https://sandbox-api.vantagepay.dev") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", client.ApiTokens.AccessToken);
var response = await http.GetAsync("/v1/content/faq");
response.EnsureSuccessStatusCode();Retrieve the help document in the requested format (JSON, HTML, or Markdown).
GET /v1/content/help
Auth: Access token (Bearer).
Parameters
| Name | In | Required | Description |
|---|---|---|---|
format | query | No | The desired output format: json, html, or md. Defaults to JSON when not specified. |
Responses
| Status | Description |
|---|---|
200 | The help content was retrieved successfully. |
400 | The request failed validation, the error object will contain further information. |
422 | The request payload is invalid, the error object will contain further information. |
429 | Too many requests are being sent concurrently or rate limiting has taken effect. |
500 | An unexpected error occurred, the error object will contain further information. |
Code samples
ts
// @vantagepay/vantagepay
// Retrieves the help content.
// Not wrapped by the JavaScript SDK - call the endpoint directly with the active token.
const response = await fetch(baseUrl + '/v1/content/help', {
method: 'GET',
headers: { Authorization: 'Bearer ' + ApiTokens.accessToken },
})
const result = await response.json()csharp
// VantagePay.SDK
// Retrieves the help content.
// Not wrapped by the .NET SDK - call the endpoint directly with an authorized HttpClient.
using var http = new HttpClient { BaseAddress = new Uri("https://sandbox-api.vantagepay.dev") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", client.ApiTokens.AccessToken);
var response = await http.GetAsync("/v1/content/help");
response.EnsureSuccessStatusCode();