Skip to content

Payin with risk info

By providing risk information during the payment process, we can detect and prevent fraud for you, saving you time in handling fraud, increasing your transaction success rate, and ensuring the security of your funds.

HTTP Request

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "7fd3ab68-1aa3-4e8f-852d-592b7250f296",
    "amount": 100000,
    "currency": "BRL",
    "country": "BR",
    "paymentMethod": "CREDIT_CARD",
    "paymentFlow": "REDIRECT",
    "callbackUrl": "https://api.client.com/callback/"
    ...  # other basic request fields
    "riskData": {
        "PAYER_IP_ADDRESS":"192.0.0.130",
        "PAYER_LOGIN_ID": "1234567890",
        "MERCHANT_APP_NAME": "Liquido"
    },
    ...  # other basic request fields
}

HTTP Headers Details

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body Parameters

Parameter Required Type Description
riskData JSON The risk data of the payment. The fields in it can be any of the Common Risks.

MERCHANT_APP_NAME or MERCHANT_WEBSITE must be provided in risk Data in riskData.

Common Risks

Name Type Description Example Note
PAYER_IP_ADDRESS string Payer IP Address 201.103.34.138
PAYER_DEVICE_ID string Payer DeviceID c9380c4c-bfc3-42c9-9120-22d1db2d53af
PAYER_AGE number Payer Age 37
PAYER_EMAIL_IS_CONFIRMED string Payer e-mail confirmed? Yes Email confirmed through a challenge link? Yes / No
PAYER_EMAIL_LAST_CHANGE_IN_DAYS number Payer last e-mail change 190 How many days
PAYER_SINCE_IN_DAYS number Payer since 190 How many days
PAYER_LAST_LOGIN_IN_DAYS number Payer last Login 5 How many days
PAYER_LAST_PASSWORD_CHANGE_IN_DAYS number Payer last password change 90 How many days
PAYER_FIRST_PURCHASE_IN_DAYS number Payer first purchase 190 How many days
PAYER_LAST_PURCHASE_IN_DAYS number Payer last purchase 60 How many days
PAYER_APPROVED_PURCHASE_COUNT number Payer approved purchases count 5
PAYER_REJECTED_PURCHASE_COUNT number Payer rejected purchases count 1
PAYER_AVG_PURCHASE_FREQUENCY number Payer purchases frequency Client since / Approved purchases count
PAYER_AVG_AMOUNT_SPENT number Payer average amount spent 212.35 Total amount of all accepted orders / Approved purchases count
PAYER_AMOUNT_DEVIATION number Payer amount deviation 1.25 Total amount of the current order / Payer's average amount spent
PAYER_PHONE_IS_CONFIRMED string Payer phone number confirmed? No Phone number confirmed through as SMS? Yes / No
PAYER_PHONE_LAST_CHANGE_IN_DAYS number Payer last phone change 190 How many days
PAYER_ADDRESS_LAST_CHANGE_IN_DAYS number Payer last address change 190 How many days
PAYER_IS_EMPLOYEE string Is payer employee? No Yes / No
PAYER_IS_VIP string Is payer VIP? No Yes / No
PAYER_LOGIN_ID string Payer login ID ivan.souza.br
ORDER_PRODUCT_TYPE string Order product type reference digital goods Enum: Physical goods / Digital goods / Services
ORDER_SHIPPING_METHOD string Shipping method Delivery Enum: Delivery / Pick-up / Digital
ORDER_NUM_PAYMENT_RETRIES number Payment retries of this order 2 In cases of authorize first, send the number of payment retries
ORDER_COUPON_CODE string Promotional coupon BABIESDAY
ORDER_USES_GIFT_CARD string Gift-card being used? No Yes / No
ORDER_GIFT_MSG string Recipient's gift message Dear sister happy birthday xxx John The message sent
ORDER_MOST_RISKY_ITEM string Most risky item on cart (gen. most expensive) Samsung Galaxy S23 Ultra
ORDER_MOST_RISKY_ITEM_TYPE string Most risky product category Smartphone Enum: Smartphone / Food / Beverages / Fashion / Home appliances / etc.
ORDER_SHIPPING_FEE number Freight price 5.15
SELLER_BUSINESS_CATEGORY string Sellers' vertical Games Enum: Games / Retail / Clothing / Health
SELLER_MARKETING_TYPE string B2C or B2B B2C
SELLER_SINCE_IN_DAYS number Seller since 2317 How many days
SELLER_AVG_ORDER_AMOUNT number Seller's average ticket 170
SELLER_AMOUNT_DEVIATION number Deviation factor of this transaction 1.47 Total amount of the current order / seller's average amount sold
MERCHANT_APP_NAME string Merchant app name The APP name associated with the payment. This field and the "merchantWebsite" field cannot both be empty.
MERCHANT_WEBSITE string Merchant website The merchant's website associated with the payment. This field and the "merchantAppName" field cannot both be empty.
Back to top