SLD API

UpdateSLD (IPS to Local Nexus Gateway)

POST /v1/sld/{country_id}
Allows IPSs to update their Service Level Descriptions.

Path Parameters

Attribute
Type
Condition
Description
Country ID
String
Mandatory
Two-letter country code

Request Body

Attribute
Type
Condition
Description
IBAN Accepted
Boolean
Mandatory
Whether IBAN is accepted
Local Account Number Format
String
Mandatory
Bank account number format
Local Bank Identifier Format
String
Mandatory
Bank identifier code or number format
Alias Conversion Available
Boolean
Mandatory
Alias Formats
Array
Conditional
    Alias Name
String
Mandatory
Name of the alias
    Alias Example
String
Optional
Example can be shown in form field placeholder
    Alias Format
String
Mandatory
Format as regex, used for validation
    Alias Description
String
Optional
Description to help the end-user
Maximum Value At Destination
Value
Mandatory
Maximum payment limit in destination currency
Account Validation Available
Boolean
Mandatory
Whether the Destination IPS and members are able to validate whether an account is active prior to payment
Confirmation Of Payee Type
Boolean
Mandatory
Type of CoP (Comparison, Nickname, RealName or None)
Screening Mandatory Fields
Array
Optional
Additional Information requested by local jurisdiction regulations to fulfil sanctions screening
IPS Mandatory Fields
Array
Optional
List of Mandatory fields required by Destination IPS for local payment instruction
IPS Timeout
Value
Mandatory
Timeout in seconds
Reachable Banks
Array
Mandatory
List of bank identifiers of banks that are enabled to receive Nexus payments. Allows the Destination Nexus Gateway to check whether the Destination Bank is reachable.

Get SLD (Source Bank to Source Nexus Gateway)

GET /v1/sld/{country_id}
Allows Source Bank to retrieve the SLD for a Destination Country.

Path Parameters

Attribute
Description
Type
Country ID
Two-letter country code
String

Response

The response body would include the full SLD, so would be identical to the Request Body for the UpdateSLD call above.
Last modified 2mo ago