Specifications

The Incoming Payments API is implemented as a series of REST calls using HTTPS verbs, with the on the wire data representation protocol being XML. At the transport layer, the API certificate based mutual authentication between the client and the server, as well as application level HTTP BASIC authentication using user name and password.

Please see the API Reference documentation for details on the calls that are available and the Host URLs through which they can be accessed.

Assumptions

The following assumptions are made in this documentation:

  1. All date and time elements produced and consumed by operations within this API are expected to be in the UTC time zone.
  2. All country and currency codes to be in 3 digit ISO format.
  3. Language code to be in LOCALE format as LANGUAGE_COUNTRY, where country may not be present in few cases.

Examples:

ID

Name

en_GB

ENGLISH - UK

fr_FR

French France

hi

Hindi

in

Indonesian

ko

Korean

zh-HANS

Simplified Chinese

zh-HANT

Traditional Chinese


Did this page help you?