Create request

post

https://demo-api.westpay.se/access/v1/onboarding/CreateRequest

Creates a onboarding request, uses the info provided from the Get info requests along with information found in the merchants acquiring agreement.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

RequestNotes

string

optional message that can be sent with the request

ParentId

string

required

Use the GetCustomers call to find out the Id of the parent for this Merchant

OrganisationNo

string

required

Address

json

required

Defaults to {"CompanyName":"Enter company name","Street":"Enter street name","ZipCode":"00000","City":"CITY NAME","Country":"Country","ContactName":"Contact name","ContactPhone":"08-000001","ContactEmail":"[email protected]"}

TransactionTypes

json

required

Defaults to {"Purchase": {"Active": true, "Password": true },"Refund": {"Active": true, "Password": true },"Reversed Acquiring": {"Active": false, "Password": null },"Cash advance": {"Active": false, "Password": true }}

Reversed Acquiring is obsolete and should always have "Active":false

AcquiringAgreements

array of objects

required

AcquiringAgreements*

Languages

array of objects

required

Defines the language that will be added to the payment terminal

Languages*

SiteLanguage

string

required

Defaults to sv-SE

Sets the portal language for this merchant, possible values: sv-SE, en-GB

MccCode

string

required

Acquirer id is received from the MCCCall call

CountryCodeNumeric

string

required

Numeric country code according to ISO-3166

CurrencyCode

string

required

Country code according to [ISO-4217)(https://en.wikipedia.org/wiki/ISO_4217)

EndOfDayTime

string

required

Defaults to 01:00

The time of the day when you prefer that your transactions is sent for settlement. Please note that we cannot guarantee the time and will change it according to what is possible based on your Acquirer and Network preferences.

Password

string

required

The password that will be used to protect certain transactions in standalone mode. Only 6 digits are allowed.

ReceiptMerchantName

string

required

The store name that should be printed on the receipt

TerminalSupportPhoneNumber

string

required

The phone number that will be displayed on the terminal in case of error situations

ReceiptPhoneNumber

string

required

The phone number printed on the receipt

Tipping

boolean

required

Defines if the terminal should have tipping enabled or not

Signature

boolean

required

Defines if the terminal should support signature as identification during payments

TerminalidOrder

json

Defaults to {"Quantity":"5","TermnialModelId":"9","TerminalOperatingModeId":"2","CustomerNotes":"test"}

Headers

Authorization

string

required

apikey {{}}

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200