v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Regulatory Reporting

List regulatory reporting codes

Returns a paginated list of regulatory reporting codes for a given market (country). Use the limit and token parameters to paginate through results. Regulatory reporting is required for cross-border payments to certain countries. See https://docs.atlar.com/docs/regulatory-reporting for more details.

get/payments/v2/regulatory-reporting-codes

Query parameters

marketstring required

Two-letter ISO 3166-1 alpha2 country code.

Example:DE

ISO 3166-1 alpha-2 country code (e.g., CL, SE, NO, IN, TH, AE, IL, ID, TW, TR).

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of regulatory reporting codes for the specified market.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "market": "DE",
      "scheme": "SCT",
      "indicator": "CREDITOR",
      "code": "20000",
      "title": "Communication, building and transport services",
      "classification": "Services"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}