Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Type

Parameter

Required

Details

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}

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

Example Request:

Code Block
breakoutModewide
languagejson
{
    "merchant_username": "acmejewellers",
    "merchant_password": "dice-vanila-purse"
}

Response Parameters:

Type

Parameter

Details

BODY

merchant_name

  • ASCII string (130)

  • Name of the merchant authenticated

BODY

merchant_id

  • number (10)

  • ID of the merchant authenticated

BODY

form_values

  • ASCII strings

  • Various values used in the credit application form

...