Payer B2B SignUp 1.0.0

Onboarding API

Server

example.com

Authentication

This header should contain your Oauth2 Token obtained from the Payer API Platform.

Fields

Key	In
Authorization	Header

Onboarding

Everything needed to onboard new & existing customers

POST

/api/v1/onboard

GET

/api/v1/onboard/sessions/{sessionId}

POST

/{merchantCallbackUrl}

Creates a new session.

Called to initiate a new onboarding session. The SDK url in the response can be used to load the Javascript SDK that can be used to initialize the frontend Widget using the provided clientToken. The sessionId in the response can be used to associate callbacks from Payer to this particular session.

Auth

Request Body application/json

CreateSessionRequest	object
callbackUrl	string	The URL to where you'd like to receive callbacks for this session maxLength: 512 minLength: 0
countryCode	string	The country code of your shop/webpage Enum: `SE`
currencyCode	string	The currency code you'd like to use for this session Enum: `SEK`
languageCode	string	The language code for the session, determines which language will be used in the Payer widget. If an unsupported language was chosen it will default to English Enum: `en`,`sv`
amount	number	The amount, in cents, that the buyer has/wants to shop for. The amount is used during credit checking.
buyer	object	The buyer information to prefill the session with
firstName	string
lastName	string
email	string
phoneNumber	string
externalReference	string	Your reference for this session. It can be useful to have the same reference when placing the order. maxLength: 48

POST /api/v1/onboard

xxxxxxxxxx
 
curl --request POST \ --url 'https://example.com/api/v1/onboard' \ --header 'Authorization: {Authorization}' \ --data '{  "callbackUrl": "{string}",  "countryCode": "{string}",  "currencyCode": "{string}",  "languageCode": "{string}",  "amount": "{number}",  "buyer": {    "firstName": "{string}",    "lastName": "{string}",    "email": "{string}",    "phoneNumber": "{string}"  },  "externalReference": "{string}"}'
Copy

Responses application/json

200

CreateSessionResponse	object
clientToken	string	Your clientToken for this session that will be used in when initiating the Frontend SDK. It's safe to expose to clients/frontends.
sdkUrl	string	The URL that can be used to load the Frontend SDK from the correct environment (depending on which environment the backend call was made towards)
sessionId	string	An ID for this particular session. It should not be exposed to clients/frontends! This is meant to be kept in your backend system, and can later be used to correlate callbacks from Payer to specific customers/sessions.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Response

xxxxxxxxxx
 
{ "clientToken": "{string}", "sdkUrl": "{string}", "sessionId": "{string}"}
Copy

Gets information of a session.

Called to get the information of an onboarding session. The information is the same as the one from the callback. The information will only be returned if the ordering customer has finished the widget flow.

Auth

Path Params

sessionId string

GET /api/v1/onboard/sessions/{sessionId}

xxxxxxxxxx
 
curl --get \ --url 'https://example.com/api/v1/onboard/sessions/%7BsessionId%7D' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

CallbackRequest	object
creditDecision	object	Contains the result of the credit decision
result	string	Approval status of the credit decision. Can be APPROVED, REJECTED, CONTROL. Enum: `APPROVED`,`REJECTED`,`CONTROL`
limitAmount	number	The amount of credit that is allowed for this customer.
limitAmountCurrencyCode	string	Enum: `SEK`
verifications	array[object]	The verifications (ID Check etc.) that have been performed already or that are pending input from customer
type	string	See general product documentation for more information about the different types. Enum: `APPROVER_VERIFICATION`,`APPROVER_SIGN`,`BANK_ID_VERIFICATION`,`EMAIL_VERIFICATION`,`CREDIT_CHECK`
status	string	See general product documentation for the meaning of the different statuses. Enum: `PENDING`,`FAILED`,`COMPLETED`,`MANUAL_CONTROL`,`ERROR`
customer	object	The person that completed the onboarding flow
firstName	string
lastName	string
email	string
phoneNumber	string
deliveryAddress	object
name	string
streetAddress1	string
streetAddress2	string
state	string
zipCode	string
city	string
invoiceAddress	object
name	string
streetAddress1	string
streetAddress2	string
state	string
zipCode	string
city	string
company	object	The company that the person placed the order on behalf of
regNumber	string
countryCode	string
legalName	string
doingBusinessAsName	string
vatId	string
sessionStatus	string	The current status of this session. See general product documentation for the meaning of the different statuses. Enum: `ERROR`,`FAILED`,`STARTED`,`MANUAL_CONTROL`,`PENDING`,`COMPLETED`
sessionId	string	The session ID that this callback refers to. This can be correlated to the session ID that was returned when creating the session initially.
externalReference	string	The reference you provided when creating new session. maxLength: 48

Expand

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Response

xxxxxxxxxx
 
{ "creditDecision": {  "result": "{string}",  "limitAmount": "{number}",  "limitAmountCurrencyCode": "{string}" }, "verifications": [  {   "type": "{string}",   "status": "{string}"  } ], "customer": {  "firstName": "{string}",  "lastName": "{string}",  "email": "{string}",  "phoneNumber": "{string}" }, "deliveryAddress": {  "name": "{string}",  "streetAddress1": "{string}",  "streetAddress2": "{string}",  "state": "{string}",  "zipCode": "{string}",  "city": "{string}" }, "invoiceAddress": {  "name": "{string}",  "streetAddress1": "{string}",  "streetAddress2": "{string}",  "state": "{string}",  "zipCode": "{string}",  "city": "{string}" }, "company": {  "regNumber": "{string}",  "countryCode": "{string}",  "legalName": "{string}",  "doingBusinessAsName": "{string}",  "vatId": "{string}" }, "sessionStatus": "{string}", "sessionId": "{string}", "externalReference": "{string}"}
Copy

Callback

Called by Payer when the status of the onboarding session has been updated. This usually means that the customer has completed the flow, and all data is available. Or that an Pending action has been completed, for example that an approver has signed the session.

The URL called is the URL supplied when creating the session.

Auth

Path Params

merchantCallbackUrl string

Request Body application/json

CallbackRequest	object
creditDecision	object	Contains the result of the credit decision
result	string	Approval status of the credit decision. Can be APPROVED, REJECTED, CONTROL. Enum: `APPROVED`,`REJECTED`,`CONTROL`
limitAmount	number	The amount of credit that is allowed for this customer.
limitAmountCurrencyCode	string	Enum: `SEK`
verifications	array[object]	The verifications (ID Check etc.) that have been performed already or that are pending input from customer
type	string	See general product documentation for more information about the different types. Enum: `APPROVER_VERIFICATION`,`APPROVER_SIGN`,`BANK_ID_VERIFICATION`,`EMAIL_VERIFICATION`,`CREDIT_CHECK`
status	string	See general product documentation for the meaning of the different statuses. Enum: `PENDING`,`FAILED`,`COMPLETED`,`MANUAL_CONTROL`,`ERROR`
customer	object	The person that completed the onboarding flow
firstName	string
lastName	string
email	string
phoneNumber	string
deliveryAddress	object
name	string
streetAddress1	string
streetAddress2	string
state	string
zipCode	string
city	string
invoiceAddress	object
name	string
streetAddress1	string
streetAddress2	string
state	string
zipCode	string
city	string
company	object	The company that the person placed the order on behalf of
regNumber	string
countryCode	string
legalName	string
doingBusinessAsName	string
vatId	string
sessionStatus	string	The current status of this session. See general product documentation for the meaning of the different statuses. Enum: `ERROR`,`FAILED`,`STARTED`,`MANUAL_CONTROL`,`PENDING`,`COMPLETED`
sessionId	string	The session ID that this callback refers to. This can be correlated to the session ID that was returned when creating the session initially.
externalReference	string	The reference you provided when creating new session. maxLength: 48

Expand

POST /{merchantCallbackUrl}

xxxxxxxxxx
 
curl --request POST \ --url 'https://example.com/%7BmerchantCallbackUrl%7D' \ --data '{  "creditDecision": {    "result": "{string}",    "limitAmount": "{number}",    "limitAmountCurrencyCode": "{string}"  },  "verifications": [    {      "type": "{string}",      "status": "{string}"    }  ],  "customer": {    "firstName": "{string}",    "lastName": "{string}",    "email": "{string}",    "phoneNumber": "{string}"  },  "deliveryAddress": {    "name": "{string}",    "streetAddress1": "{string}",    "streetAddress2": "{string}",    "state": "{string}",    "zipCode": "{string}",    "city": "{string}"  },  "invoiceAddress": {    "name": "{string}",    "streetAddress1": "{string}",    "streetAddress2": "{string}",    "state": "{string}",    "zipCode": "{string}",    "city": "{string}"  },  "company": {    "regNumber": "{string}",    "countryCode": "{string}",    "legalName": "{string}",    "doingBusinessAsName": "{string}",    "vatId": "{string}"  },  "sessionStatus": "{string}",  "sessionId": "{string}",  "externalReference": "{string}"}'
Copy

Responses application/json

200

object object

Response

xxxxxxxxxx
 
{}
Copy