Skip to content

    Relay API v2

    Notification Service

    Used to subscribe to Relay notifications.

    Create

    Define the events you want to subscribe to. Returns the notification_configuration_id.

    CreateRequest

    • request_id
      string
    • events
      stringrepeated
    • webhook_configuration_data
      • url
        string

    CreateResponse

    • notification_configuration_id
      stringoptional
    • status
      • code
        int32

        This corresponds to google.rpc.Status.code.

      • message
        string

        This corresponds to google.rpc.Status.message.

      • details
        repeated

        This corresponds to google.rpc.Status.details.

      Get

      Returns the events you’ve subscribed to.

      GetRequest

      • notification_configuration_id
        string

      GetResponse

      • events
        stringrepeated
      • webhook_configuration_data
        • url
          string
      • status
        • code
          int32

          This corresponds to google.rpc.Status.code.

        • message
          string

          This corresponds to google.rpc.Status.message.

        • details
          repeated

          This corresponds to google.rpc.Status.details.

        Delete

        Used to delete existend subscriptions.

        DeleteRequest

        • notification_configuration_id
          string

        DeleteResponse

        • status
          • code
            int32

            This corresponds to google.rpc.Status.code.

          • message
            string

            This corresponds to google.rpc.Status.message.

          • details
            repeated

            This corresponds to google.rpc.Status.details.

          Update

          Update existend subscriptions.

          UpdateRequest

          • notification_configuration_id
            string
          • events
            stringrepeated
          • webhook_configuration_data
            • url
              string

          UpdateResponse

          • status
            • code
              int32

              This corresponds to google.rpc.Status.code.

            • message
              string

              This corresponds to google.rpc.Status.message.

            • details
              repeated

              This corresponds to google.rpc.Status.details.

            Merchant Service

            Used to register and maintain merchants in our system. The responsibility for the merchant data to be valid is yours.

            Create

            CreateRequest

            • reference
              string

              Regex: ^.{1,36}$ - must be unique for each merchant

            • enabled_for_consolidated_payout
              bool

              True, if merchant will be used in a setup that includes collecting

            • merchant_data

              In case of a direct merchant payout integration, the merchant data could be null; in such a case, the enabled_for_consolidated_payout property must be false

              • name
                string

                Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

              • registration_number
                string

                Regex: ^[0-9a-zA-Z-]{1,128}$

              • dba_name
                string

                Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

              • country_code
                string

                Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

              • incorporation_date

                Not mandatory (null allowed)

                • year
                  int32

                  Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                • month
                  int32

                  Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                • day
                  int32

                  Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

              • mcc
                string

                Format: ISO-18245 Regex: ^[0-9]{4}$

              • vat_number
                stringoptional

                Regex: ^[0-9a-zA-Z]{1,128}$

              • email
                stringoptional

                Regex: ^\S+@\S+.\S+$

              • phone_number
                stringoptional

                Regex: ^[+]?[0-9]{8,19}$

              • website
                string

                Regex: ^(www|http:|https:)+[^\s]+[\w]$

                • address_line1
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                • address_line2
                  stringoptional

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                • postal_code
                  string

                  Regex: ^[0-9a-zA-Z- ]{1,31}$

                • city
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • state
                  stringoptional

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • country_code
                  string

                  Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

              • invoice_address
                • address_line1
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                • address_line2
                  stringoptional

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                • postal_code
                  string

                  Regex: ^[0-9a-zA-Z- ]{1,31}$

                • city
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • state
                  stringoptional

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • country_code
                  string

                  Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

              • monthly_transactions
                repeated

                Cardinality: 1:N

                • average_count
                  int64
                • average_amount
                  int64

                  Format: ISO-4217 - Minor units of currency

                • currency
                  string

                  Format: ISO-4217 - Alphabetic Currency Code

                • Option 1
                  INDIVIDUAL
                • Option 2
                  ORGANIZATIONAL
                • Option 3
                  PARTNERSHIP
                • Option 4
                  NON_PROFIT_ORGANIZATION
              • stakeholders
                repeated

                Cardinality: 1:N

                • first_name
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • middle_name
                  stringoptional

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • last_name
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • roles
                  repeated

                  Cardinality: 1:N

                  • Option 1
                    BENEFICIAL_OWNER
                  • Option 2
                    SENIOR_MANAGEMENT
                  • Option 3
                    BOARD_OF_DIRECTORS
                  • Option 4
                    PARTNER
                • date_of_birth
                  • year
                    int32

                    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                  • month
                    int32

                    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                  • day
                    int32

                    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                • address
                  • address_line1
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • address_line2
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • postal_code
                    string

                    Regex: ^[0-9a-zA-Z- ]{1,31}$

                  • city
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • state
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • country_code
                    string

                    Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                • nationalities
                  stringrepeated

                  Cardinality: 1:N Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                • ownership_percentage
                  float
                • email
                  stringoptional

                  Regex: ^\S+@\S+.\S+$

                • phone_number
                  stringoptional

                  Regex: ^[+]?[0-9]{8,19}$

                • social_security_number
                  string

                  Regex: ^[0-9a-zA-Z-]{1,128}$

                • politically_exposed_person
                  bool
                • sanctioned
                  bool
              • owning_companies
                repeated

                Cardinality: 0:N

                • name
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • registration_number
                  string

                  Regex: ^[0-9a-zA-Z-]{1,128}$

                • country_code
                  string

                  Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • address_line1
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • address_line2
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • postal_code
                    string

                    Regex: ^[0-9a-zA-Z- ]{1,31}$

                  • city
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • state
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • country_code
                    string

                    Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                • ownership_type
                  • Option 1
                    GLOBAL_ULTIMATE_OWNER

                    GUO

                  • Option 2
                    OTHER_ULTIMATE_BENEFICIARY

                    OUB Other Ultimate Beneficiary

                • stakeholders
                  repeated

                  Cardinality: 1:N

                  • first_name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • middle_name
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • last_name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • roles
                    repeated

                    Cardinality: 1:N

                    • Option 1
                      BENEFICIAL_OWNER
                    • Option 2
                      SENIOR_MANAGEMENT
                    • Option 3
                      BOARD_OF_DIRECTORS
                    • Option 4
                      PARTNER
                  • date_of_birth
                    • year
                      int32

                      Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                    • month
                      int32

                      Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                    • day
                      int32

                      Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                  • address
                    • address_line1
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • address_line2
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • postal_code
                      string

                      Regex: ^[0-9a-zA-Z- ]{1,31}$

                    • city
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • state
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • country_code
                      string

                      Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • nationalities
                    stringrepeated

                    Cardinality: 1:N Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • ownership_percentage
                    float
                  • email
                    stringoptional

                    Regex: ^\S+@\S+.\S+$

                  • phone_number
                    stringoptional

                    Regex: ^[+]?[0-9]{8,19}$

                  • social_security_number
                    string

                    Regex: ^[0-9a-zA-Z-]{1,128}$

                  • politically_exposed_person
                    bool
                  • sanctioned
                    bool

            CreateResponse

            • merchant_id
              stringoptional
            • status
              • code
                int32

                This corresponds to google.rpc.Status.code.

              • message
                string

                This corresponds to google.rpc.Status.message.

              • details
                repeated

                This corresponds to google.rpc.Status.details.

              Get

              Returns the data stored for that merchant_id.

              GetRequest

              • merchant_id
                string

              GetResponse

              • merchant_data
                • name
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • registration_number
                  string

                  Regex: ^[0-9a-zA-Z-]{1,128}$

                • dba_name
                  string

                  Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                • country_code
                  string

                  Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                • incorporation_date

                  Not mandatory (null allowed)

                  • year
                    int32

                    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                  • month
                    int32

                    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                  • day
                    int32

                    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                • mcc
                  string

                  Format: ISO-18245 Regex: ^[0-9]{4}$

                • vat_number
                  stringoptional

                  Regex: ^[0-9a-zA-Z]{1,128}$

                • email
                  stringoptional

                  Regex: ^\S+@\S+.\S+$

                • phone_number
                  stringoptional

                  Regex: ^[+]?[0-9]{8,19}$

                • website
                  string

                  Regex: ^(www|http:|https:)+[^\s]+[\w]$

                  • address_line1
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • address_line2
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • postal_code
                    string

                    Regex: ^[0-9a-zA-Z- ]{1,31}$

                  • city
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • state
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • country_code
                    string

                    Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                • invoice_address
                  • address_line1
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • address_line2
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                  • postal_code
                    string

                    Regex: ^[0-9a-zA-Z- ]{1,31}$

                  • city
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • state
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • country_code
                    string

                    Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                • monthly_transactions
                  repeated

                  Cardinality: 1:N

                  • average_count
                    int64
                  • average_amount
                    int64

                    Format: ISO-4217 - Minor units of currency

                  • currency
                    string

                    Format: ISO-4217 - Alphabetic Currency Code

                  • Option 1
                    INDIVIDUAL
                  • Option 2
                    ORGANIZATIONAL
                  • Option 3
                    PARTNERSHIP
                  • Option 4
                    NON_PROFIT_ORGANIZATION
                • stakeholders
                  repeated

                  Cardinality: 1:N

                  • first_name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • middle_name
                    stringoptional

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • last_name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • roles
                    repeated

                    Cardinality: 1:N

                    • Option 1
                      BENEFICIAL_OWNER
                    • Option 2
                      SENIOR_MANAGEMENT
                    • Option 3
                      BOARD_OF_DIRECTORS
                    • Option 4
                      PARTNER
                  • date_of_birth
                    • year
                      int32

                      Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                    • month
                      int32

                      Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                    • day
                      int32

                      Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                  • address
                    • address_line1
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • address_line2
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • postal_code
                      string

                      Regex: ^[0-9a-zA-Z- ]{1,31}$

                    • city
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • state
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • country_code
                      string

                      Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • nationalities
                    stringrepeated

                    Cardinality: 1:N Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • ownership_percentage
                    float
                  • email
                    stringoptional

                    Regex: ^\S+@\S+.\S+$

                  • phone_number
                    stringoptional

                    Regex: ^[+]?[0-9]{8,19}$

                  • social_security_number
                    string

                    Regex: ^[0-9a-zA-Z-]{1,128}$

                  • politically_exposed_person
                    bool
                  • sanctioned
                    bool
                • owning_companies
                  repeated

                  Cardinality: 0:N

                  • name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • registration_number
                    string

                    Regex: ^[0-9a-zA-Z-]{1,128}$

                  • country_code
                    string

                    Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                    • address_line1
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • address_line2
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • postal_code
                      string

                      Regex: ^[0-9a-zA-Z- ]{1,31}$

                    • city
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • state
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • country_code
                      string

                      Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • ownership_type
                    • Option 1
                      GLOBAL_ULTIMATE_OWNER

                      GUO

                    • Option 2
                      OTHER_ULTIMATE_BENEFICIARY

                      OUB Other Ultimate Beneficiary

                  • stakeholders
                    repeated

                    Cardinality: 1:N

                    • first_name
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • middle_name
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • last_name
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • roles
                      repeated

                      Cardinality: 1:N

                      • Option 1
                        BENEFICIAL_OWNER
                      • Option 2
                        SENIOR_MANAGEMENT
                      • Option 3
                        BOARD_OF_DIRECTORS
                      • Option 4
                        PARTNER
                    • date_of_birth
                      • year
                        int32

                        Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                      • month
                        int32

                        Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                      • day
                        int32

                        Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                    • address
                      • address_line1
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                      • address_line2
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                      • postal_code
                        string

                        Regex: ^[0-9a-zA-Z- ]{1,31}$

                      • city
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • state
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • country_code
                        string

                        Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                    • nationalities
                      stringrepeated

                      Cardinality: 1:N Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                    • ownership_percentage
                      float
                    • email
                      stringoptional

                      Regex: ^\S+@\S+.\S+$

                    • phone_number
                      stringoptional

                      Regex: ^[+]?[0-9]{8,19}$

                    • social_security_number
                      string

                      Regex: ^[0-9a-zA-Z-]{1,128}$

                    • politically_exposed_person
                      bool
                    • sanctioned
                      bool
              • reference
                stringoptional
              • enabled_for_consolidated_payout
                bool
              • merchant_status
                • Option 1
                  CREATED
                • Option 2
                  ENABLED
                • Option 3
                  DISABLED
              • status
                • code
                  int32

                  This corresponds to google.rpc.Status.code.

                • message
                  string

                  This corresponds to google.rpc.Status.message.

                • details
                  repeated

                  This corresponds to google.rpc.Status.details.

                Update

                UpdateRequest

                • merchant_id
                  string
                • enabled_for_consolidated_payout
                  bool

                  True, if merchant will be used in a setup that includes collecting

                • merchant_data

                  In case of a direct merchant payout integration, the merchant data could be null; in case it is null, the enabled_for_consolidated_payout property must be false

                  • name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • registration_number
                    string

                    Regex: ^[0-9a-zA-Z-]{1,128}$

                  • dba_name
                    string

                    Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                  • country_code
                    string

                    Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • incorporation_date

                    Not mandatory (null allowed)

                    • year
                      int32

                      Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                    • month
                      int32

                      Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                    • day
                      int32

                      Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                  • mcc
                    string

                    Format: ISO-18245 Regex: ^[0-9]{4}$

                  • vat_number
                    stringoptional

                    Regex: ^[0-9a-zA-Z]{1,128}$

                  • email
                    stringoptional

                    Regex: ^\S+@\S+.\S+$

                  • phone_number
                    stringoptional

                    Regex: ^[+]?[0-9]{8,19}$

                  • website
                    string

                    Regex: ^(www|http:|https:)+[^\s]+[\w]$

                    • address_line1
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • address_line2
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • postal_code
                      string

                      Regex: ^[0-9a-zA-Z- ]{1,31}$

                    • city
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • state
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • country_code
                      string

                      Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • invoice_address
                    • address_line1
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • address_line2
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                    • postal_code
                      string

                      Regex: ^[0-9a-zA-Z- ]{1,31}$

                    • city
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • state
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • country_code
                      string

                      Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                  • monthly_transactions
                    repeated

                    Cardinality: 1:N

                    • average_count
                      int64
                    • average_amount
                      int64

                      Format: ISO-4217 - Minor units of currency

                    • currency
                      string

                      Format: ISO-4217 - Alphabetic Currency Code

                    • Option 1
                      INDIVIDUAL
                    • Option 2
                      ORGANIZATIONAL
                    • Option 3
                      PARTNERSHIP
                    • Option 4
                      NON_PROFIT_ORGANIZATION
                  • stakeholders
                    repeated

                    Cardinality: 1:N

                    • first_name
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • middle_name
                      stringoptional

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • last_name
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • roles
                      repeated

                      Cardinality: 1:N

                      • Option 1
                        BENEFICIAL_OWNER
                      • Option 2
                        SENIOR_MANAGEMENT
                      • Option 3
                        BOARD_OF_DIRECTORS
                      • Option 4
                        PARTNER
                    • date_of_birth
                      • year
                        int32

                        Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                      • month
                        int32

                        Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                      • day
                        int32

                        Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                    • address
                      • address_line1
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                      • address_line2
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                      • postal_code
                        string

                        Regex: ^[0-9a-zA-Z- ]{1,31}$

                      • city
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • state
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • country_code
                        string

                        Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                    • nationalities
                      stringrepeated

                      Cardinality: 1:N Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                    • ownership_percentage
                      float
                    • email
                      stringoptional

                      Regex: ^\S+@\S+.\S+$

                    • phone_number
                      stringoptional

                      Regex: ^[+]?[0-9]{8,19}$

                    • social_security_number
                      string

                      Regex: ^[0-9a-zA-Z-]{1,128}$

                    • politically_exposed_person
                      bool
                    • sanctioned
                      bool
                  • owning_companies
                    repeated

                    Cardinality: 0:N

                    • name
                      string

                      Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                    • registration_number
                      string

                      Regex: ^[0-9a-zA-Z-]{1,128}$

                    • country_code
                      string

                      Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                      • address_line1
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                      • address_line2
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                      • postal_code
                        string

                        Regex: ^[0-9a-zA-Z- ]{1,31}$

                      • city
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • state
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • country_code
                        string

                        Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                    • ownership_type
                      • Option 1
                        GLOBAL_ULTIMATE_OWNER

                        GUO

                      • Option 2
                        OTHER_ULTIMATE_BENEFICIARY

                        OUB Other Ultimate Beneficiary

                    • stakeholders
                      repeated

                      Cardinality: 1:N

                      • first_name
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • middle_name
                        stringoptional

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • last_name
                        string

                        Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                      • roles
                        repeated

                        Cardinality: 1:N

                        • Option 1
                          BENEFICIAL_OWNER
                        • Option 2
                          SENIOR_MANAGEMENT
                        • Option 3
                          BOARD_OF_DIRECTORS
                        • Option 4
                          PARTNER
                      • date_of_birth
                        • year
                          int32

                          Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                        • month
                          int32

                          Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                        • day
                          int32

                          Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                      • address
                        • address_line1
                          string

                          Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                        • address_line2
                          stringoptional

                          Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,255}$, expression includes support for extended European Latin characters

                        • postal_code
                          string

                          Regex: ^[0-9a-zA-Z- ]{1,31}$

                        • city
                          string

                          Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                        • state
                          stringoptional

                          Regex: ^[0-9A-Za-zÀ-ÖØ-öø-ÿĀ-ȳ&,-‘'. ]{1,128}$, expression includes support for extended European Latin characters

                        • country_code
                          string

                          Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                      • nationalities
                        stringrepeated

                        Cardinality: 1:N Format: ISO-3166 Alpha 3 Regex: ^[A-Z][A-Z][A-Z]$

                      • ownership_percentage
                        float
                      • email
                        stringoptional

                        Regex: ^\S+@\S+.\S+$

                      • phone_number
                        stringoptional

                        Regex: ^[+]?[0-9]{8,19}$

                      • social_security_number
                        string

                        Regex: ^[0-9a-zA-Z-]{1,128}$

                      • politically_exposed_person
                        bool
                      • sanctioned
                        bool

                UpdateResponse

                • status
                  • code
                    int32

                    This corresponds to google.rpc.Status.code.

                  • message
                    string

                    This corresponds to google.rpc.Status.message.

                  • details
                    repeated

                    This corresponds to google.rpc.Status.details.

                  Enable

                  EnableRequest

                  • merchant_id
                    string

                  EnableResponse

                  • status
                    • code
                      int32

                      This corresponds to google.rpc.Status.code.

                    • message
                      string

                      This corresponds to google.rpc.Status.message.

                    • details
                      repeated

                      This corresponds to google.rpc.Status.details.

                    Disable

                    DisableRequest

                    • merchant_id
                      string

                    DisableResponse

                    • status
                      • code
                        int32

                        This corresponds to google.rpc.Status.code.

                      • message
                        string

                        This corresponds to google.rpc.Status.message.

                      • details
                        repeated

                        This corresponds to google.rpc.Status.details.

                      Enrollment Service

                      Used to enroll registered merchants for additional payment methods and to get or update a merchant’s payment method related data.

                      EnrollRequest

                      • request_id
                        string

                        Regex: ^.{1,36}$, idempotency is implemented based on it

                      • reference
                        string

                        Allows up to 36 characters and MUST NOT be empty (Regex: ^.{1,36}$). For your own reference (e.g. platform enrollment id, terminal id). You should choose a unique value.

                      • payment_method_provider

                        MUST be one of the listed values. Determines the specific payment method provider you will use to enable the payment method. Find a list of available payment methods per payment method provider in our guide section.

                        • Option 1
                          PMP_UNSPECIFIED
                        • Option 2
                          PMP_PPRO
                        • Option 3
                          PMP_EXPRESS_BANK
                        • Option 4
                          PMP_PAYTRAIL
                        • Option 5
                          PMP_TWINT
                      • payment_method
                        • Option 1
                          UNSPECIFIED
                        • Option 2
                          TRUSTLY
                        • Option 3
                          SOFORT
                        • Option 4
                          IDEAL
                        • Option 5
                          BANCONTACT
                        • Option 6
                          EXPRESS_BANK
                        • Option 7
                          EPS
                        • Option 8
                          GIROPAY
                        • Option 9
                          WECHAT
                        • Option 10
                          ALIPAY
                        • Option 11
                          PAYTRAIL
                        • Option 12
                          TWINT
                      • merchant_id
                        string

                        Relay merchant id

                      • data

                        Consolidated or direct merchant payout specific data

                        • Option 1
                          expressbank directmerchantpayout
                          • enroll_data
                            • partner_id
                              int64

                              Partner ID code

                            • product_group_id
                              int64

                              Financial product agreement ID

                            • event_record_pass_key
                              string

                              Unique key used in cancel and capture operations

                            • finance_pass_key
                              string

                              Unique key used in refund operations

                            • currency
                              string

                              Assigned currency for partner ID. Format: ISO-4217 alpha code, e.g. EUR, USD, GBP

                        • Option 2
                          paytrail consolidatedpayout
                          • Option 3
                            alipay consolidatedpayout
                            • Option 4
                              bancontact consolidatedpayout
                              • Option 5
                                eps consolidatedpayout
                                • Option 6
                                  giropay consolidatedpayout
                                  • Option 7
                                    ideal consolidatedpayout
                                    • Option 8
                                      sofort consolidatedpayout
                                      • Option 9
                                        trustly consolidatedpayout
                                        • Option 10
                                          wechat consolidatedpayout
                                          • Option 11
                                            twint directmerchantpayout

                                            this data is used in an direct merchant payout integration model; Relay will process payments on behalf of the merchant

                                            • enroll_data
                                              • merchant_id
                                                string

                                                Twint merchant UUID

                                        EnrollResponse

                                        The response to your EnrollRequest call.

                                        • payment_method_configuration_id
                                          stringoptional
                                        • data
                                          google.protobuf.Any

                                          Consolidated or direct merchant payout specific data returned.

                                        • status
                                          • code
                                            int32

                                            This corresponds to google.rpc.Status.code.

                                          • message
                                            string

                                            This corresponds to google.rpc.Status.message.

                                          • details
                                            repeated

                                            This corresponds to google.rpc.Status.details.

                                          Update

                                          Used to update an existing payment method enrollment request.

                                          UpdateRequest

                                          Used to update an existing payment method enrollment request.

                                          • payment_method_configuration_id
                                            string
                                          • data

                                            Consolidated or direct merchant payout specific data

                                            • Option 1
                                              expressbank directmerchantpayout
                                              • enroll_data
                                                • partner_id
                                                  int64

                                                  Partner ID code

                                                • product_group_id
                                                  int64

                                                  Financial product agreement ID

                                                • event_record_pass_key
                                                  string

                                                  Unique key used in cancel and capture operations

                                                • finance_pass_key
                                                  string

                                                  Unique key used in refund operations

                                                • currency
                                                  string

                                                  Assigned currency for partner ID. Format: ISO-4217 alpha code, e.g. EUR, USD, GBP

                                            • Option 2
                                              paytrail consolidatedpayout
                                              • Option 3
                                                alipay consolidatedpayout
                                                • Option 4
                                                  bancontact consolidatedpayout
                                                  • Option 5
                                                    eps consolidatedpayout
                                                    • Option 6
                                                      giropay consolidatedpayout
                                                      • Option 7
                                                        ideal consolidatedpayout
                                                        • Option 8
                                                          sofort consolidatedpayout
                                                          • Option 9
                                                            trustly consolidatedpayout
                                                            • Option 10
                                                              wechat consolidatedpayout
                                                              • Option 11
                                                                twint directmerchantpayout
                                                                • enroll_data
                                                                  • merchant_id
                                                                    string

                                                                    Twint merchant UUID

                                                            UpdateResponse

                                                            • status
                                                              • code
                                                                int32

                                                                This corresponds to google.rpc.Status.code.

                                                              • message
                                                                string

                                                                This corresponds to google.rpc.Status.message.

                                                              • details
                                                                repeated

                                                                This corresponds to google.rpc.Status.details.

                                                              Get

                                                              Returns the payment method enrollment status for the corresponding payment_method_configuration_id.

                                                              GetRequest

                                                              Returns the payment method enrollment status for the corresponding payment_method_configuration_id.

                                                              • payment_method_configuration_id
                                                                string

                                                              GetResponse

                                                              • payment_method_enrollment_status
                                                                • Option 1
                                                                  PENDING
                                                                • Option 2
                                                                  ACTIVATED
                                                                • Option 3
                                                                  NON_COMPLIANT
                                                                • Option 4
                                                                  DEACTIVATED
                                                                • Option 5
                                                                  TERMINATED
                                                              • status_reason
                                                                stringoptional
                                                              • reference
                                                                string
                                                              • payment_method_provider

                                                                MUST be one of the listed values. Determines the specific payment method provider you will use to enable the payment method. Find a list of available payment methods per payment method provider in our guide section.

                                                                • Option 1
                                                                  PMP_UNSPECIFIED
                                                                • Option 2
                                                                  PMP_PPRO
                                                                • Option 3
                                                                  PMP_EXPRESS_BANK
                                                                • Option 4
                                                                  PMP_PAYTRAIL
                                                                • Option 5
                                                                  PMP_TWINT
                                                              • payment_method

                                                                MUST be one of the listed values. Determines the specific payment method you want to enable. The payment method MUST be available for the chosen payment_method_provider. Find a list of available payment methods per payment method provider in our guide section

                                                                • Option 1
                                                                  UNSPECIFIED
                                                                • Option 2
                                                                  TRUSTLY
                                                                • Option 3
                                                                  SOFORT
                                                                • Option 4
                                                                  IDEAL
                                                                • Option 5
                                                                  BANCONTACT
                                                                • Option 6
                                                                  EXPRESS_BANK
                                                                • Option 7
                                                                  EPS
                                                                • Option 8
                                                                  GIROPAY
                                                                • Option 9
                                                                  WECHAT
                                                                • Option 10
                                                                  ALIPAY
                                                                • Option 11
                                                                  PAYTRAIL
                                                                • Option 12
                                                                  TWINT
                                                              • merchant_id
                                                                string

                                                                Relay merchant_id: You MUST have received the merchant_id using the Merchant Services CreateRequest.

                                                              • data

                                                                Consolidated or direct merchant payout specific data. Determines whether or not the payout to the merchant is processed directly by the payment method provider or by Relay. From the options below, the chosen payment method provider specific format MUST be used. Example: If your chosen payment method provider is express bank, then the express bank account format is required.

                                                                • Option 1
                                                                  expressbank directmerchantpayout
                                                                  • enroll_data
                                                                    • partner_id
                                                                      int64

                                                                      Partner ID code

                                                                    • product_group_id
                                                                      int64

                                                                      Financial product agreement ID

                                                                    • event_record_pass_key
                                                                      string

                                                                      Unique key used in cancel and capture operations

                                                                    • finance_pass_key
                                                                      string

                                                                      Unique key used in refund operations

                                                                    • currency
                                                                      string

                                                                      Assigned currency for partner ID. Format: ISO-4217 alpha code, e.g. EUR, USD, GBP

                                                                • Option 2
                                                                  twint directmerchantpayout
                                                                  • enroll_data
                                                                    • merchant_id
                                                                      string

                                                                      Twint merchant UUID

                                                              • status
                                                                • code
                                                                  int32

                                                                  This corresponds to google.rpc.Status.code.

                                                                • message
                                                                  string

                                                                  This corresponds to google.rpc.Status.message.

                                                                • details
                                                                  repeated

                                                                  This corresponds to google.rpc.Status.details.

                                                                APM Processing Service

                                                                Used to process your customer’s alternate payment method’s (APM) payments. Which calls are applicable depends on the used payment method.

                                                                Authorize

                                                                Used to authorize payments were applicable.

                                                                AuthorizeRequest

                                                                • payment_method_configuration_id
                                                                  string
                                                                • request_id
                                                                  string

                                                                  Regex: ^.{1,36}$, idempotency is implemented based on it

                                                                • operation_reference
                                                                  string

                                                                  Regex: ^.{1,36}$, e.g. platform authorization id

                                                                • payment_reference
                                                                  string

                                                                  Regex: ^.{1,36}$, e.g. platform payment id

                                                                • order
                                                                  • amount
                                                                    int64

                                                                    Format: ISO-4217, Minor units of currency, e.g. Amount=100, Currency=EUR -> 1.00 EUR

                                                                  • currency
                                                                    string

                                                                    Format: ISO-4217 alpha code, e.g. EUR, USD, GBP

                                                                  • reference
                                                                    stringoptional

                                                                    Merchant specific reference, e.g. invoice number

                                                                • data

                                                                  Payment method specific information

                                                                  • Option 1
                                                                    paymentmethods expressbank
                                                                    • payment_flow_redirect_request_data
                                                                      • success_url
                                                                        string

                                                                        PaymentId and AuthorizeId are appended as query parameters

                                                                      • failed_url
                                                                        string

                                                                        PaymentId and AuthorizeId are appended as query parameters

                                                                    • items
                                                                      stringrepeated

                                                                      Regex: ^.{1,30}$

                                                                    • capture_reconciliation_reference
                                                                      string

                                                                      ExpressBank does not accept a reconciliation reference in ShipSignal call (capture). The reconciliation reference must be sent in the Prefilling call (authorize), this being the reason why it is present here too. This exact same value must be also sent in the capture call (Relay level), for consistancy.

                                                                  • Option 2
                                                                    paymentmethods twint
                                                                    • payment_flow_redirect_request_data
                                                                      • success_url
                                                                        string

                                                                        PaymentId and AuthorizeId/ChargeId are appended as query parameters.

                                                                      • failed_url
                                                                        string

                                                                        PaymentId and AuthorizeId/ChargeId are appended as query parameters.

                                                                      • cancel_url
                                                                        string

                                                                        PaymentId and AuthorizeId/ChargeId are appended as query parameters.

                                                                    • capture_reconciliation_reference
                                                                      string

                                                                      Twint does not accept a reconciliation reference in ConfirmOrder call (capture). The reconciliation reference must be sent in the StartOrder call, this being the reason why it is present here too. This exact same value must be also sent in the capture call (Relay level), for consistancy.

                                                                AuthorizeResponse

                                                                • payment_id
                                                                  stringoptional
                                                                • authorization_id
                                                                  stringoptional
                                                                • data

                                                                  Payment method specific information

                                                                  • Option 1
                                                                    paymentmethods expressbank
                                                                    • payment_flow_redirect_response_data
                                                                      • approval_url
                                                                        string
                                                                  • Option 2
                                                                    paymentmethods twint
                                                                    • payment_flow_redirect_response_data
                                                                      • approval_url
                                                                        string
                                                                • status
                                                                  • code
                                                                    int32

                                                                    This corresponds to google.rpc.Status.code.

                                                                  • message
                                                                    string

                                                                    This corresponds to google.rpc.Status.message.

                                                                  • details
                                                                    repeated

                                                                    This corresponds to google.rpc.Status.details.

                                                                  Cancel

                                                                  Used to cancel payments were applicable.

                                                                  CancelRequest

                                                                  • payment_id
                                                                    string
                                                                  • request_id
                                                                    string

                                                                    Regex: ^.{1,36}$, idempotency is implemented based on it

                                                                  • operation_reference
                                                                    string

                                                                    Regex: ^.{1,36}$, e.g. platform cancel id

                                                                  • data
                                                                    google.protobuf.Any

                                                                    Payment method specific information

                                                                  CancelResponse

                                                                  • cancel_id
                                                                    stringoptional
                                                                  • data
                                                                    google.protobuf.Any

                                                                    Payment method specific information

                                                                  • status
                                                                    • code
                                                                      int32

                                                                      This corresponds to google.rpc.Status.code.

                                                                    • message
                                                                      string

                                                                      This corresponds to google.rpc.Status.message.

                                                                    • details
                                                                      repeated

                                                                      This corresponds to google.rpc.Status.details.

                                                                    Capture

                                                                    Used to capture payments were applicable.

                                                                    CaptureRequest

                                                                    • payment_id
                                                                      string
                                                                    • request_id
                                                                      string

                                                                      Regex: ^.{1,36}$, idempotency is implemented based on it

                                                                    • operation_reference
                                                                      string

                                                                      Regex: ^.{1,36}$, e.g. platform capture id

                                                                    • reconciliation_reference
                                                                      string

                                                                      Regex: ^.{1,36}$, the value of this field will be pressent in the settlement material or remittence orders

                                                                    • amount
                                                                      int64
                                                                    • data
                                                                      google.protobuf.Any

                                                                      Payment method specific information

                                                                    CaptureResponse

                                                                    • capture_id
                                                                      stringoptional
                                                                    • data
                                                                      google.protobuf.Any

                                                                      Payment method specific information

                                                                    • status
                                                                      • code
                                                                        int32

                                                                        This corresponds to google.rpc.Status.code.

                                                                      • message
                                                                        string

                                                                        This corresponds to google.rpc.Status.message.

                                                                      • details
                                                                        repeated

                                                                        This corresponds to google.rpc.Status.details.

                                                                      Charge

                                                                      Used to charge payments were applicable.

                                                                      ChargeRequest

                                                                      • payment_method_configuration_id
                                                                        string
                                                                      • request_id
                                                                        string

                                                                        Regex: ^.{1,36}$, idempotency is implemented based on it

                                                                      • operation_reference
                                                                        string

                                                                        Regex: ^.{1,36}$, e.g. platform charge id

                                                                      • payment_reference
                                                                        string

                                                                        Regex: ^.{1,36}$, e.g. platform payment id

                                                                      • reconciliation_reference
                                                                        string

                                                                        Regex: ^.{1,36}$, the value of this field will be pressent in the settlement material or remittence orders

                                                                      • order
                                                                        • amount
                                                                          int64

                                                                          Format: ISO-4217, Minor units of currency, e.g. Amount=100, Currency=EUR -> 1.00 EUR

                                                                        • currency
                                                                          string

                                                                          Format: ISO-4217 alpha code, e.g. EUR, USD, GBP

                                                                        • reference
                                                                          stringoptional

                                                                          Merchant specific reference, e.g. invoice number

                                                                      • data

                                                                        Payment method specific information

                                                                        • Option 1
                                                                          paymentmethods paytrail
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string
                                                                            • failed_url
                                                                              string
                                                                            • locale
                                                                              string

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • email
                                                                              string

                                                                              Regex: ^\S+@\S+.\S+$

                                                                            • first_name
                                                                              string

                                                                              Regex: ^[0-9a-zA-Z&,-‘'. ]{1,128}$

                                                                            • last_name
                                                                              string

                                                                              Regex: ^[0-9a-zA-Z&,-‘'. ]{1,128}$

                                                                            • phone_number
                                                                              string

                                                                              Regex: ^[+]?[0-9]{8,19}$

                                                                            • delivery_address
                                                                              • address_line1
                                                                                string

                                                                                Regex: ^.{1,255}

                                                                              • postal_code
                                                                                string

                                                                                Regex: ^[0-9a-zA-Z- ]{1,31}

                                                                              • city
                                                                                string

                                                                                Regex: [0-9a-zA-Z- ]{1,128}

                                                                              • country_code
                                                                                string

                                                                                Format: ISO-3166 Alpha 3. Regex: ^[A-Z][A-Z][A-Z]$

                                                                            • invoice_address
                                                                              • address_line1
                                                                                string

                                                                                Regex: ^.{1,255}

                                                                              • postal_code
                                                                                string

                                                                                Regex: ^[0-9a-zA-Z- ]{1,31}

                                                                              • city
                                                                                string

                                                                                Regex: [0-9a-zA-Z- ]{1,128}

                                                                              • country_code
                                                                                string

                                                                                Format: ISO-3166 Alpha 3. Regex: ^[A-Z][A-Z][A-Z]$

                                                                        • Option 2
                                                                          ppro alipay
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                            • display_mobile_view
                                                                              bool

                                                                              Display a QR code. Set to True to display a QR code on Alipay�s payment page. The consumer can scan the code to proceed with the payment on their mobile device

                                                                            • hotel

                                                                              Mandatory only for Merchant Type: Hotel

                                                                              • name
                                                                                string

                                                                                The name of the hotel for which the reservation was made

                                                                              • check_in_date
                                                                                repeated

                                                                                The date of the check-in in UTC

                                                                                • year
                                                                                  int32

                                                                                  Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                                                                                • month
                                                                                  int32

                                                                                  Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                                                                                • day
                                                                                  int32

                                                                                  Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                                                                              • check_out_date
                                                                                repeated

                                                                                The date of the check-out in UTC. Number of check-out times should match the number of check-in times

                                                                                • year
                                                                                  int32

                                                                                  Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

                                                                                • month
                                                                                  int32

                                                                                  Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

                                                                                • day
                                                                                  int32

                                                                                  Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

                                                                            • flights
                                                                              repeated

                                                                              Mandatory only for Merchant Type: Aviation

                                                                              • number
                                                                                string

                                                                                The number of the flight.

                                                                              • departure_time
                                                                                google.protobuf.Timestamp

                                                                                The date and time of departure of the flight in UTC

                                                                            • overseas_education_admission_notice_url
                                                                              stringoptional

                                                                              The URL of the admission notice. Mandatory only for Merchant Type: Overseas Education

                                                                            • order_items
                                                                              repeated

                                                                              Information about the goods being sold. Mandatory only for Merchant Type: Retailing

                                                                              • name
                                                                                string
                                                                              • quantity
                                                                                int64
                                                                        • Option 3
                                                                          ppro bancontact
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • app_to_app_url
                                                                              string

                                                                              Custom app URL for redirecting the consumer back to the app

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                        • Option 4
                                                                          ppro eps
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                        • Option 5
                                                                          ppro giropay
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                        • Option 6
                                                                          ppro ideal
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                            • bic
                                                                              string

                                                                              Optional - Bank identifier Regex: [A-Z]{6,6}[A-Z2-9]A-NP-Z0-9{0,1} eg. RABONL2U, TRIONL2U, KNABNL2H

                                                                        • Option 7
                                                                          ppro sofort
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                        • Option 8
                                                                          ppro trustly
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                            • reference
                                                                              string
                                                                        • Option 9
                                                                          ppro wechat
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and ChargeId are appended as query parameters

                                                                            • locale
                                                                              stringoptional

                                                                              Format: RFC 1766, e.g. zh-CN, zh-TW, en-US

                                                                          • consumer

                                                                            B2C

                                                                            • name
                                                                              string
                                                                            • country_code
                                                                              string

                                                                              Format: ISO 3166-1 alpha-3, e.g. NOR, SWE, DNK

                                                                        • Option 10
                                                                          paymentmethods twint
                                                                          • payment_flow_redirect_request_data
                                                                            • success_url
                                                                              string

                                                                              PaymentId and AuthorizeId/ChargeId are appended as query parameters.

                                                                            • failed_url
                                                                              string

                                                                              PaymentId and AuthorizeId/ChargeId are appended as query parameters.

                                                                            • cancel_url
                                                                              string

                                                                              PaymentId and AuthorizeId/ChargeId are appended as query parameters.

                                                                      ChargeResponse

                                                                      • payment_id
                                                                        stringoptional
                                                                      • charge_id
                                                                        stringoptional
                                                                      • data

                                                                        Payment method specific information

                                                                        • Option 1
                                                                          paymentmethods paytrail
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 2
                                                                          ppro alipay
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 3
                                                                          ppro bancontact
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 4
                                                                          ppro eps
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 5
                                                                          ppro giropay
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 6
                                                                          ppro ideal
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 7
                                                                          ppro sofort
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 8
                                                                          ppro trustly
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 9
                                                                          ppro wechat
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                        • Option 10
                                                                          paymentmethods twint
                                                                          • payment_flow_redirect_response_data
                                                                            • approval_url
                                                                              string
                                                                      • status
                                                                        • code
                                                                          int32

                                                                          This corresponds to google.rpc.Status.code.

                                                                        • message
                                                                          string

                                                                          This corresponds to google.rpc.Status.message.

                                                                        • details
                                                                          repeated

                                                                          This corresponds to google.rpc.Status.details.

                                                                        Refund

                                                                        Used to refund payments that have been completed.

                                                                        RefundRequest

                                                                        • payment_id
                                                                          string
                                                                        • request_id
                                                                          string

                                                                          Regex: ^.{1,36}$, idempotency is implemented based on it

                                                                        • operation_reference
                                                                          string

                                                                          Regex: ^.{1,36}$, e.g. platform refund id

                                                                        • reconciliation_reference
                                                                          string

                                                                          Regex: ^.{1,36}$, the value of this field will be pressent in the settlement material or remittence orders

                                                                        • amount
                                                                          int64
                                                                        • data

                                                                          Payment method specific information

                                                                          • Option 1
                                                                            paymentmethods expressbank
                                                                            • reason_code

                                                                              Express Bank refund reason code

                                                                              • Option 1
                                                                                DEFECT_IN_PRODUCT
                                                                              • Option 2
                                                                                CUSTOMER_CHANGED_HIS_MIND
                                                                              • Option 3
                                                                                PRODUCT_RECALLED
                                                                              • Option 4
                                                                                TECHNICAL_OR_HUMAN_ERROR
                                                                          • Option 2
                                                                            paymentmethods paytrail
                                                                            • email
                                                                              string

                                                                              Regex: ^\S+@\S+.\S+$

                                                                        RefundResponse

                                                                        • refund_id
                                                                          stringoptional
                                                                        • data
                                                                          google.protobuf.Any

                                                                          Payment method specific information

                                                                        • status
                                                                          • code
                                                                            int32

                                                                            This corresponds to google.rpc.Status.code.

                                                                          • message
                                                                            string

                                                                            This corresponds to google.rpc.Status.message.

                                                                          • details
                                                                            repeated

                                                                            This corresponds to google.rpc.Status.details.

                                                                          Get summary

                                                                          Used to get the details of a payment according to the payment_id you sent.

                                                                          GetSummaryRequest

                                                                          • payment_id
                                                                            string

                                                                          GetSummaryResponse

                                                                          • authorized_amount
                                                                            int64
                                                                          • captured_amount
                                                                            int64
                                                                          • canceled_amount
                                                                            int64
                                                                          • refunded_amount
                                                                            int64
                                                                          • currency
                                                                            string
                                                                          • payment_reference
                                                                            string
                                                                          • status
                                                                            • code
                                                                              int32

                                                                              This corresponds to google.rpc.Status.code.

                                                                            • message
                                                                              string

                                                                              This corresponds to google.rpc.Status.message.

                                                                            • details
                                                                              repeated

                                                                              This corresponds to google.rpc.Status.details.

                                                                            Get operations summary

                                                                            GetOperationsSummaryRequest

                                                                            • payment_id
                                                                              string

                                                                            GetOperationsSummaryResponse

                                                                            • operations
                                                                              repeated
                                                                              • id
                                                                                string
                                                                              • operation
                                                                                • Option 1
                                                                                  AUTHORIZE
                                                                                • Option 2
                                                                                  CANCEL
                                                                                • Option 3
                                                                                  CHARGE
                                                                                • Option 4
                                                                                  REFUND
                                                                                • Option 5
                                                                                  CAPTURE
                                                                              • amount
                                                                                int64
                                                                              • last_updated
                                                                                google.protobuf.Timestamp
                                                                              • operation_reference
                                                                                string

                                                                                It is provided by the platform as an indentifier for the operation

                                                                              • reconciliation_reference
                                                                                stringoptional

                                                                                It is provided by the platform for capture, charge and refund operations only, and will be present in the settlement material or remittance orders

                                                                              • currency
                                                                                string
                                                                              • status
                                                                                • Option 1
                                                                                  PENDING
                                                                                • Option 2
                                                                                  COMPLETED
                                                                                • Option 3
                                                                                  FAILED
                                                                              • error
                                                                                • code
                                                                                  string
                                                                                • message
                                                                                  string
                                                                            • payment_reference
                                                                              string
                                                                            • status
                                                                              • code
                                                                                int32

                                                                                This corresponds to google.rpc.Status.code.

                                                                              • message
                                                                                string

                                                                                This corresponds to google.rpc.Status.message.

                                                                              • details
                                                                                repeated

                                                                                This corresponds to google.rpc.Status.details.

                                                                              Card Processing Service

                                                                              Card Processing Service will be documented here soon.