Create Crypto Checkout

API Overview

Item	Value
API Status	Stable
Current Version	v1.0
Backward Compatibility	Yes
Applicable Environment	Production

Description
Create a crypto checkout.

Mandatory buyer info:

field	Individual Buyer (<1000 USD)	Individual Buyer (≥1000 USD)
fullLegalName	mandatory	mandatory
residentialAddress	-	mandatory : Pick one of the three
identityNumber	-	mandatory : Pick one of the three
dateOfBirth & placeOfBirth	-	mandatory : Pick one of the three

字段	Corporate Buyer (<1000 USD)	Corporate Buyer (≥1000 USD)
companyName	mandatory	mandatory
registeredAddress	-	mandatory : Pick one of the three
businessRegistrationNumber	-	mandatory : Pick one of the three
dateOfRegistration & countryOfIncorporation	-	mandatory : Pick one of the three

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "participantCode": "string",
    "amountToPay": 0,
    "currencyToPay": "string",
    "clientReference": "string",
    "paymentPurpose": {
        "subject": "string",
        "description": "string",
        "supportingDocuments": "string"
    },
    "buyerInfo": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "identityType": 1,
        "identityNumber": "string",
        "dateOfBirth": "2019-08-24",
        "placeOfBirth": "string",
        "residentialAddress": {
            "country": "string",
            "state": "string",
            "city": "string",
            "postcode": "string",
            "addressLine1": "string",
            "addressLine2": "string"
        }
    },
    "expiry": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "code": "string",
    "msg": "string",
    "data": {
        "cryptoCheckoutId": "string",
        "participantCode": "string",
        "amountToPay": 0,
        "currencyToPay": "string",
        "clientReference": "string",
        "paymentPurpose": {
            "subject": "string",
            "description": "string",
            "supportingDocuments": "string"
        },
        "buyerInfo": {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "identityType": 1,
            "identityNumber": "string",
            "dateOfBirth": "2019-08-24",
            "placeOfBirth": "string",
            "residentialAddress": {}
        },
        "checkoutWallets": {
            "walletKey": "string",
            "addressList": [
                {
                    "blockchain": "string",
                    "address": "string",
                    "acceptableCurrencies": [
                        "string"
                    ]
                }
            ]
        },
        "status": 1,
        "expiry": 0,
        "walletKyt": {
            "kytResult": 1,
            "kytDetails": "string",
            "walletAddress": "string"
        },
        "receivedPayments": [
            {
                "blockchain": "string",
                "sourceWalletAddress": "string",
                "paidCurrency": "string",
                "paidAmount": "string",
                "txnHash": "string",
                "walletType": 1,
                "platformName": "string",
                "platformUserName": "string",
                "kytInfo": {}
            }
        ],
        "conversions": [
            {
                "conversionId": "string",
                "quotationId": "string",
                "participantCode": "string",
                "clientReference": "string",
                "sourceCurrency": "string",
                "destinationCurrency": "string",
                "price": "string",
                "sourceAmount": "string",
                "destinationAmount": "string",
                "status": 1,
                "createdAt": 0
            }
        ]
    }
}