Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Compliance

Fetch a kyb transactions list

get/compliance/transaction

Query parameters

merchantIdstring
Example:156

The id identifying the merchant

namestring
Example:Example merchant

Name of the aggregated merchant declared in a kyb

referencestring
Example:ref_<merhcantId>_<name>/<anything>

The reference of the kyb transaction (unique per merchantId)

fromstring
Example:2020-10-15T12:09:49.355Z

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

tostring
Example:2020-10-15T12:09:49.355Z

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

status'created' | 'pending' | 'rejected' | 'validated'
Example:created

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

isKybDeletedboolean
Example:true

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

perPagenumber
Example:5

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

pagenumber
Example:2

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

Headers

ApiKeystring 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.

MerchantIdstring 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'live' | 'sandbox' required

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

Response

idnumber required

The id identifying the transaction

referencestring required

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

amountnumber required

Amount of the transaction

currencystring required

Currency in which the transaction has been done

createdAtstring date-time required

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

status'created' | 'pending' | 'rejected' | 'validated' required

Enum indicating the status of the kyb transaction

rejectionReasonstring

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

ibanstring required

Iban of the bank account on which funds have been transferred

Example response

[
  {
    "id": 1,
    "kyb": {
      "merchantId": "156",
      "name": "Example merchant",
      "businessType": "Fintech",
      "country": "CI",
      "id": 1,
      "createdAt": "2020-10-15T12:09:49.355Z"
    },
    "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"
  }
]