Skip to main content
Version: 1.0.0

Create a new signup session

POST 

https://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. Briqpay Signup Sequence

Request

Body

    countrystringrequired
    localestringrequired
    cinstring

    Company identication number

    merchanturls objectrequired
    termsstring
    signupwebhookstring

    If you want to validate the signup from your backend. you should provide Briqpay with this url for us to notify you of a completed registration. This validation is also possible to complete using a frontend notification.

    redirecturlstring

    If you want the signup to automatically redirect after completion

Responses

successully created a signup session

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
    termsstring
    Example: https://example.com/ToC
    signupwebhookstring

    The url where Briqpay should post data for you to validate the registration

    Example: https://example.com/signup-hook-handler
    redirecturlstring

    The page where Briqpay should redirect the customer after a successful registration

    Example: https://example.com/registration-completed
    statestring
    merchantidstring

    Your merchant ID in briqpays system

    merchantnamestring

    Your merchant Name in briqpays system

    validationFlowstring

Authorization: http

name: bearerAuthtype: httpbearerFormat: JWTscheme: bearer
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());
Request Collapse all
Base URL
https://playground-api.briqpay.com
Auth
Body
{
  "country": "string",
  "locale": "string",
  "cin": "string",
  "merchanturls": {
    "terms": "string",
    "signupwebhook": "string",
    "redirecturl": "string"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!