Page Comparison

FORMDATA

client_id

Yes

• ASCII string (100)

• This is the Client ID given in the Developer User Account section

FORMDATA

client_secret

Yes

• ASCII string (100)

• This is the Client Secret given in the Developer User Account section

HEADER

x-reference-id

Yes

• ASCII string (32)

• GUID

• Unique identifier for the flow for traceability purposes

BODY

grant_type

• ASCII string

• This is the client's access type

• possible values: 'password', 'refresh_token', 'client_credentials'

• default value: 'client_credentials'

BODY

refresh_token

• ASCII string

• only to be used with the grant_type: refresh_token.

• It should be the refresh_token attribute in the last response of this method.

BODY

scope

• ASCII string

• Available values: ‘customer', 'merchant’

• Default value: merchant

HEADER

bearer token

Yes

• ASCII string (1000)

• This is the word “Bearer” with a space and then the access_token given in oauth/token API response

• Default value: Bearer {insert_bearer_token_from_oauth_here/token_api}

HEADER

x-reference-id

Yes

• ASCII string (32)

• GUID

• Unique identifier for the flow for traceability purposes

PATH

client_id

Yes

• ASCII string (100)

• This is the Client ID given in the Developer User Account section

QUERY

lang

• ASCII string (2)

• Customer Preferred language

• Available values: (en=English) or (fr=French)

• Default: en

BODY

merchant_username

• ASCII string

• Optional information to log in a specific Sales Representative or Merchant location

BODY

merchant_password

• ASCII string

• Optional information to log in a specific Sales Representative or Merchant location