Endpoint specification

Data API allows partners to retrieve information about your users and any orders associated with your Partner ID.


Request method: GET

Endpoint URL:

Sandbox:Endpoint
Partner's Ordershttps://partner-sandbox.wert.io/api/external/orders
Partner's Usershttps://partner-sandbox.wert.io/api/external/users
Production:Endpoint
Partner's Ordershttps://partner.wert.io/api/external/orders
Partner's Usershttps://partner.wert.io/api/external/users

Headers:

Key: X-API-KEY
Value: wert-sbox-xxxxxxxxxxxx

ℹ️

You must replace 'wert-sbox-xxxxxxxxxxxx' with your personal API key. You can request this by contacting our partner support.


Request parameters

The Data API can make use of the following parameters:

ParameterData TypeDescription
limitNumberThe number of orders you want to retrieve. Defaults to 10.
offsetNumberSkips specified number of orders. Defaults to 0.
search_byString with order or click IDAllows setting an order or click ID to find a specific order.
order_byasc / descAllows setting the order as ascending or descending. Defaults to desc.

Examples Of Request

Retrieving the ten most recent orders:

curl -X GET 'https://partner.wert.io/api/external/orders' \
-H 'X-API-KEY: wert-sbox-xxxxxxxxxxxx'

Retrieving the 20 orders which were made after the first 10 orders:

curl -X GET -G 'https://partner.wert.io/api/external/orders' \
-H 'X-API-KEY: wert-prod-aaaaaaaaaaaaaaa'\ 
-d 'limit=20' \
-d 'offset=10' \
-d 'order_by=asc'

Retrieving an order using the click ID:

curl -X GET -G 'https://partner.wert.io/api/external/orders' \
-H 'X-API-KEY: wert-prod-aaaaaaaaaaaaaaa'\ 
-d 'search_by=click_id'

Response parameters

The response contains the following:

VariableDescription
successWhether the request was successfully processed and produced a result
dataAn object with the orders which were retrieved from the API
totalThe total number of orders which match the criteria for the search

Order parameters

Each order in the data object will include the following:

VariableDescriptionFilterableFilter name
order_idThe unique identifier for the order in Wert's databaseYessearch_by
click_idThe identifier you pass to Wert when you initialise the widgetYessearch_by
currencyThe base currency for the orderNo
currency_amountThe value of the order in the base currencyNo
cryptoThe crypto asset which was purchased or sent to the smart contractYescommodity
crypto_amountThe amount of the crypto asset which was purchased or sent to the smart contractNo
user_idThe unique identifier for the user in Wert's databaseYesuser_id
statusThe status of the orderYesstatus
card_idThe unique identifier for the card which was used in Wert's databaseYescard_id
created_atTimestamp of when the order was created (UTC)No
changed_atTimestamp of when the order was last updated (UTC)No
partner_feeThe USD amount of fees which were collected as partner revenueNo
partner_fee_percentThe percentage of fees which were collected as partner revenueNo
wert_feeThe USD amount of fees which were collected as Wert revenueNo
wert_fee_percentThe percentage of fees which were collected as Wert revenueNo
tx_idBlockchain transaction hashYestx_id
processed_throughThe acquirer who processed the card paymentNo
card_brandVisa or MastercardNo
fail_reasonPayment error code, refer to description of error code.Yesfail_reason
payment_typeThe authentication method of the payment, e.g "3ds_v2"Yes
additional_dataAdditional informationNo
sc_input_dataSmart contract Input data that was sent in the transactionNo

The following order statuses are available:

StatusDescription
successThe order was successful and has been sent on the blockchain
failedThe order has failed and will not be sent on the blockchain
cancelledThe payment for the order was processed but the order was later cancelled
pendingThe order is being processed but it hasn't been sent on the blockchain
progressThe order is being processed but payment has not yet been completed
createdThe order has been created but payment has not yet been processed

Payment Error Codes

Error codeDescription
4000We weren’t able to charge the user’s card and the order was not completed. The user can try again.
4001The transaction failed due to an incorrect CVV/CVC. The user can try again ensuring they enter the correct CVV/CVC.
4002
4010
4012
Payment was declined by the card issuer. The user should contact them for further details.
4003Incorrect card details. The user can try again ensuring they enter valid card details.
4004Insufficient balance. The user should add funds to their card and try again.
4005Card limit was exceeded. The user should use a different card to complete their purchase.
4011Card validation failed. The user can add a valid card and try again.
4013We weren’t able to charge the user’s card and the order was not completed. The user should contact support for further assistance.

User parameters

VariableDescriptionFilterableFilter Name
user_idUser's Wert IDYesuser_ids
countryUser's KYC countryYeskyc_country
phone_countryUsers phone countryYesphone_country
lkyc_statusUsers non-document verification statusYeslkyc_status
fkyc_statusUsers document verification statusYesfkyc_status
bannedIs the user banned by WertNo

Example of Response

Response from Orders endpoint:

{
    "success": true,
    "data": [
        {
            "order_id": "01HNWX0HSK85WW9W5A3RZS1BBH",
            "click_id": "82960ad6-e52c-48b1-9293-5658709da384",
            "currency": "usd",
            "currency_amount": 1.07,
            "crypto": "matic.simple.polygon",
            "crypto_amount": 1.28928444,
            "user_id": "01HNWWXZ8FQ9FSH08A8ACHH7K1",
            "status": "success",
            "card_id": "01HNWWZ6E1T0BJT46H35M42JT7",
            "created_at": "2024-02-05 15:08:29",
            "changed_at": "2024-02-05 15:08:32",
            "partner_fee": 0,
            "partner_fee_percent": 0,
            "wert_fee": 0.04,
            "wert_fee_percent": 0.04,
            "tx_id": "0xbef4262a7c56f64423b80e4342ee4309595dcdb78d8c201fd752dc1d9c29c19e",
            "processed_through": "safecharge",
            "card_brand": "VISA",
            "fail_reason": "",
            "payment_type": "non_3ds",
            "additional_data": null
        },
        {
            "order_id": "01HMXQ6AN3XKQAZHPRSM13ED3X",
            "click_id": "click_id",
            "currency": "usd",
            "currency_amount": 5,
            "crypto": "tt_goerli.erc-20.ethereum",
            "crypto_amount": 4.36051815,
            "user_id": "01HMVWY6V7B9ZHA6P2C48AP5C7",
            "status": "failed",
            "card_id": "01HMVX1NJB6QDW5YKXA13HB2CG",
            "created_at": "2024-01-24 12:30:20",
            "changed_at": "2024-01-24 12:30:27",
            "partner_fee": 0,
            "partner_fee_percent": 0,
            "wert_fee": 0.19,
            "wert_fee_percent": 0.04,
            "tx_id": "",
            "processed_through": "safecharge",
            "card_brand": "VISA",
            "fail_reason": "4007",
            "payment_type": "unknown",
            "additional_data": null
        }
    ],
    "total": 2
}

Response from Users endpoint:

{
    "success": true,
    "data": [
        {
            "user_id": "01HPPKVTKC3VKXC95ADA8M5JTA",
            "country": "FRA",
            "phone_country": "FR",
            "lkyc_status": "success",
            "fkyc_status": "not initiated",
            "banned": ""
        },
        {
            "user_id": "01HNWG569RD40SF98FHSS3BTAN",
            "country": "",
            "phone_country": "US",
            "lkyc_status": "not initiated",
            "fkyc_status": "not initiated",
            "banned": ""
        }
    ],
    "total": 2
}


Documentation related to this page