Method: HTTP POST
Format: JSON
Direction: POS (integrator) -> Gateway
When a new merchant is boarded by Opayo at the request of the POS Integrator, Opayo creates a temporary initial password that is specific to the merchant and provide this to the integrator. This password is set as expired within the gateway, so the integrator must use this API call to change the password for the merchant site.
The initial password is used to validate the merchant via HTTP Basic Authentication method when sending a Setup Merchant request. The gateway creates and returns the new password to the integrator. The integrator can then prime the merchant site/POS with the new password.
An HTTP response code of 200 indicates that the new password has been successfully created and assigned to the specified merchant.
Request
The Setup Merchant request is constructed with the Header section.
SetupMerchantRequest
{
Header{…}
}Header Section
|
Field |
Min |
Max |
Format |
Description |
|---|---|---|---|---|
|
ProtocolVersion |
3 |
3 |
"^([0-9.]*)$" |
Packet protocol version. Set as 1.0. |
|
MerchantId |
5 |
12 |
"^([a-zA-Z0-9-_]*)$" |
Each merchant (site) is assigned a unique merchant identifier that must be presented in each request. |
|
PosID |
1 |
32 |
"^([a-zA-Z0-9-_]*)$" |
POS should indicate the name of the POS station. This value is not used by the gateway but is echoed back in the Payment response. |
|
ClientDateTime |
25 |
25 |
"YYYY-MM-DDTHH:mm:ss+hh:mm" |
Date and time of the POS with time zone offset from GMT. |
|
ClientTransactionReference |
36 |
36 |
"^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$" |
POS must create a GUID for the transaction and present it in the request in this field. |
|
Attempt |
1 |
5 |
"^([0-9]*)$" |
This field should always be set to '1'. If the POS does not receive a response to a Setup Merchant request, it can reissue another Setup Merchant request but with a newly created ClientTransactionReference. |
Response
The Setup Merchant response is constructed with the following sections:
SetupMerchantResponse
{
Header{…}
Detail{…}
}Header Section
The Setup Merchant response echoes back the header section as received in the Setup Merchant request.
Detail Section
|
Field |
Min |
Max |
Format |
Description |
|---|---|---|---|---|
|
NewPassword |
20 |
20 |
“^[a-z,A-Z,0-9,*.! @#$%^&(){}[]:;<>,.?/~_+-=|\]$” |
If the initial password is successfully validated by the gateway, the gateway will create a complex password and return it to this field. |