GET
/
compliance
/
transaction

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Query Parameters

name
string

Name of the aggregated merchant declared in a kyb

from
string

A date in UTC timezone to filters data from, inclusively. Follows the Datetime ISO. The default value is the first day of this month.

to
string

A date in UTC timezone to filters data to, inclusively. Follows the Datetime ISO. The default value is now().

status
enum<string>

Status of a kyb transaction. It can be eithet 'created' or 'validated'

Available options:
created,
pending,
rejected,
validated
perPage
number

The maximum number of results that will be return. The default value is 10. Do use with 'page' query parameter to paginate properly.

page
number

The page number in the returned data. The default value is 1. Do use with 'perPage' query parameter to paginate properly.

Response

200 - application/json
id
number
required

The id identifying the transaction

kyb
object
required

The kyb related to the transaction

reference
string
required

Reference of the transaction. Should be unique for a given merchantId

amount
number
required

Amount of the transaction

currency
string
required

Currency in which the transaction has been done

createdAt
string
required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

status
enum<string>
required

Enum indicating the status of the kyb transaction

Available options:
created,
pending,
rejected,
validated
Create a kybCreate a kyb transaction