Payout 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

Request Headers

{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

Request Body

{
    "idempotencyKey": "idempotency-key",
    "country": "BR",
    "targetName": "Luiz Carlos",
    "targetEmail": "Patoshowp@gmail.com",
    "targetDocument": "97198102549",
    "targetBankCode": "036",
    "targetBankAgency": "3563",
    "targetBankAccountId": "72346",
    "amountInCents": 150,
    "currency": "BRL",
    ...  # other basic request fields
    "riskData": {
        "PAYER_IP_ADDRESS":"192.0.0.130",
        "MERCHANT_WEBSITE": "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
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.