Auth Refresh

All Payments authorized (and not captured) has a preset expiration of 7 days. Use this API to refresh and extend the expiration.

The auth refresh model

The auth refresh model is used to refresh the authorization token expiration.

Properties

Name
orderid
Type
string
Description
The unique id of the order
Name
transaction_receipt
Type
string
Description
The transaction receipt of the order

POST/custom/auth/refresh

Create a auth refresh

This endpoint allows you to refresh the authorization token.

Required attributes

Name
orderid
Type
string
Description
The unique id of the order
Name
transaction_receipt
Type
string
Description
The transaction receipt of the order

Request

POST

/custom/auth/refresh

curl -X POST https://stagingapi.platform.poweredbytandym.com/custom/auth/refresh \
  -H 'content-type:application/json' \
  -H 'apiKey:{YOURPAY_API_KEY}' \
  -H 'secret:{YOURPAY_API_SECRET}' \
  -d '{
        "orderid":557,
        "transaction_receipt":"2c42b592-e172-4fde-8bc1-3d456008b014",
      }'

Success Response

{
  "refreshed": 1
}

Error Response

{
  "refreshed": 0,
  "errorcode": "AUTH_REFRESH_UNSUCCESSFUL",
  "errormessage": "Auth Refresh is not successful!"      
}