Skip to main content

Send One-time Login Link

Send a one-time login link to the customer's account at PayPro Global.

Request Parametersapplication/json
OnetimeLoginEmailRequestModel
object
customerEmail
string
The customer's email address.
(required if orderId is not passed).
orderId
integer
The order ID that was assigned to the customer's purchase.
(required if customerEmail is not passed)
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
OnetimeLoginEmailResponseModel
object
request
object
customerEmail
string
The customer's email address.
orderId
integer
The order ID that was assigned to the customer's purchase.
vendorAccountId
integer
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
"customerEmail": "[email protected]",
"orderId": 5482730,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"customerEmail": "[email protected]",
"orderId": 5482730,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
},
"errors": [
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
},
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
}
],
"isSuccess": false
}