Sign In Customer

Sign-in from a backend service on behalf of a consumer customer (B2C) or customer delegate (B2B). Used by custom integrations and e-commerce plugins as a form of single-sign-on for the checkout. If the customer has been authenticated with the merchant's website, this lets them also authenticate a known customer with April. This is a pre-requisite for using the checkout for a B2B customer.

For both B2B and B2C customers having an authenticated session with the checkout also unlocks access to saved cards as a payment source.

Note merchants need to have been registered as supporting B2B customer when onboarded to be able to support B2B customers in the checkout.

SecurityMarketplace Api Key | Merchant Secret Token | Pay By Link Token
Request
header Parameters
Merchant-Id
string

Perform operation in the context of the given merchant. Usually not required — specify only if acting on behalf of a merchant not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
One of:
required
object (SignInConsumer1)

Sign in on behalf of a B2C consumer customer.

Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/auth/signin
Request samples
application/json
{
  • "SignInConsumer": {
    }
}
Response samples
application/json
{
  • "customerId": "cust_ZnJjj4nTNWr8wwNK",
  • "customToken": "string"
}
Copyright © April Solutions 2023. All right reserved.