GET
/
compliance
/
transaction
[
  {
    "id": 1,
    "kyb": {
      "merchantId": "156",
      "name": "Example merchant",
      "businessType": "Fintech",
      "businessRegistrationId": "<string>",
      "taxNumber": "<string>",
      "directorName": "<string>",
      "websiteUrl": "<string>",
      "country": "CI",
      "headquarterAddress": "<string>",
      "id": 1,
      "createdAt": "2020-10-15T12:09:49.355Z",
      "deletedAt": null
    },
    "reference": "<REPLACE_BY_YOUR_REFERENCE>",
    "amount": 100,
    "currency": "XOF",
    "createdAt": "2020-10-15T12:09:49.355Z",
    "status": "created",
    "rejectionReason": "Your request is not compliant with our policies for the following reason: ...",
    "iban": "CI93CI0080111301134291200589"
  }
]

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

​
merchantId
string

The id identifying the merchant

​
name
string

Name of the aggregated merchant declared in a kyb

​
reference
string

The reference of the kyb transaction (unique per merchantId)

​
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
​
isKybDeleted
boolean

Either the kyb transaction is related to a deleted kyb or not

​
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

Example:

1

​
kyb
object
required

The kyb related to the transaction

​
reference
string
required

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

Example:

"<REPLACE_BY_YOUR_REFERENCE>"

​
amount
number
required

Amount of the transaction

Example:

100

​
currency
string
required

Currency in which the transaction has been done

Example:

"XOF"

​
createdAt
string
required

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

Example:

"2020-10-15T12:09:49.355Z"

​
status
enum<string>
required

Enum indicating the status of the kyb transaction

Available options:
created,
pending,
rejected,
validated
Example:

"created"

​
iban
string
required

Iban of the bank account on which funds have been transferred

Example:

"CI93CI0080111301134291200589"

​
rejectionReason
string

The reason why a kyb transaction has been rejected by Hub2 teams (i.e, the deposit hasn't been done)

Example:

"Your request is not compliant with our policies for the following reason: ..."