Skip to content


    Relay is a collection of API (Application Program Interface) services. These servics allow you to perform various payment related actions.

    Relay services are gRPC services. Each of them consists of RPC methods as described in the coresponding protobuf files.

    RPC methods take a request message and return a response message. The following reference lists all available request messages, their parameters and the response messages.

    Depending on your specific use case, you can combine methods from different services. A few main use cases and the required succession of method calls are described in the guide section.

    Environments and service URLs

    EnvironmentBase address

    Supported TLS versions

    TLS 1.2 is the only secure protocol available when connecting towards Nexi's Relay services. Please make sure TLS 1.2 is supported and used in your systems for all operations.


    All fields in the Relay messages are validated according to the following validation rules:


    Any of characters a-z, A-Z and 0-9 are supported.


    Reference values are currently validated on length alone. The max length for the reference value is given in the max length field in API section.


    Boolean parameters need to be given in text form; a string set to either "true" or "false" is supported.


    Valid base64-encoded values are supported.


    URLs that are max 256 characters and start with the string "http://" or "https://" are supported.


    Timestamps are returned with the format YYYY-MM-DDTHH:MM:SS.milliseconds+TZ. Time zone is optional. For example: 2017-02-15T14:35:19.305+01:00


    The field can contain any printable characters.


    The validation of the field is specific for the field and cannot be described in general. Custom fields typically map to enumerations, but can be anything.