Skip to content

OAuth

Access tokens

POST- oauth/tokens/refresh (1)

AUTHORIZATIONS (2)

  1. Sandbox server (uses test data)
    https://api.sandbox.payerly.tech/v1/oauth/tokens/refresh
    Production server (uses live data)
    https://api.payerly.tech/v1/oauth/tokens/refresh

  2. BearerAuth

REQUEST BODY SCHEMA: application/json

Parameter Type Description
refreshToken string Current refresh token
Request samples 
  {
      "refreshToken": "string"

  }
RESPONSE HEADERS:
Parameter Type Description
Date string(date-time) The Date header indicates the server time.
RESPONSE SCHEMA: application/json
Parameter Type Description
accessToken string Access token
accessTokenExpireAt string (date-time) Access token expires at
refreshToken string Refresh token
refreshTokenExpireAt string (date-time) Refresh token expires at
error object Error object:
- code:Error code
- description:Error description
-traceId:Unique request trace id (for support requests)
- details:Errors details array
    -value:Error brief
    -description:Error description
    -fields:Errors fields array:
        -name:Filed name
        -type:Location of field (body, header)
        -value:Field value
200 
  {
      "accessToken": "string",
      "accessTokenExpireAt": "2019-08-24T14:15:22Z",
      "refreshToken": "string",
      "refreshTokenExpireAt": "2019-08-24T14:15:22Z"

  }
400 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
405 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
429 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
default 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }