Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Compliance

Create a kyb transaction

post/compliance/transaction

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.

Request body

namestring required

The name of the aggregated merchant

referencestring required

Reference of the transaction

amountnumber required

Amount of the transaction

currencystring required

Currency in which the transaction has been done

ibanstring required

International Bank Account Number (IBAN)

Example request

{
  "name": "Example merchant",
  "reference": "<REPLACE_BY_YOUR_REFERENCE>",
  "amount": 100,
  "currency": "XOF",
  "iban": "FR7630006000011234567890189"
}

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"
}