Create a new signup session
POSThttps://playground-api.briqpay.com/signup/v1/session
First step in the signup process is to generate a signup session.
The response will provide you with a snippet that you should render in your frontend.
Request
- application/json
Body
countrystringrequired
localestringrequired
cinstring
Company identication number
merchanturls objectrequired
Responses
- 201
successully created a signup session
- application/json
- Schema
- Example (auto)
Schema
createddatestring
Timestamp of when the registration started
Example:
localestring
Example:
en-gb
countrystring
Example:
SE
sessionidstring
snippetstring
the snippet to be presented in your frontend
Example:
<script>......</script>
merchanturls object
statestring
merchantidstring
Your merchant ID in briqpays system
merchantnamestring
Your merchant Name in briqpays system
validationFlowstring
{
"createddate": "",
"locale": "en-gb",
"country": "SE",
"sessionid": "string",
"snippet": "<script>......</script>",
"merchanturls": {
"terms": "https://example.com/ToC",
"signupwebhook": "https://example.com/signup-hook-handler",
"redirecturl": "https://example.com/registration-completed"
},
"state": "string",
"merchantid": "string",
"merchantname": "string",
"validationFlow": "string"
}
Authorization: http
name: bearerAuthtype: httpbearerFormat: JWTscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://playground-api.briqpay.com/signup/v1/session");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n \"country\": \"string\",\n \"locale\": \"string\",\n \"cin\": \"string\",\n \"merchanturls\": {\n \"terms\": \"string\",\n \"signupwebhook\": \"string\",\n \"redirecturl\": \"string\"\n }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear