# Lottery
How to use Lottery to submit a payin in Brazil.
# Post
https://gateway-test.transfersmile.com/trade/pay
# Payin by Lottery
This endpoint allows you to submit a payin by Lottery in Brazil.
# Parameters
# Header
Content-Type* | string | application/json; chartset=UTF-8 |
Authorization* | string | Basic Base($app_id:$security_key) |
# Body
app_id* | string | created app's id at dashboard - Max. 32 chars - |
timestamp* | string | yyyy-MM-dd HH:mm:ss - Max. 19 chars - |
out_trade_no* | string | ID given by the merchant in their system - Max. 64 chars - |
method* | string | Fixed value: Lottery |
order_currency* | string | Fixed value: BRL |
order_amount* | string | payment amount - 4~2000 BRL - |
subject* | string | payment reason or item title - Max. 128 chars - |
content* | string | payment reason detail or item detail. This will be shown on the bank bill. - Max. 255 chars - |
notify_url* | string | Where transfersmile will send notification to |
return_url | string | Redirect to Merchant's url when user finished checkout |
timeout_express | string | Used to control the expiration time of submitting an order (from initial to processing). (90m in default, max 15d) |
cancellation_express | string | m(minutes), h(hours), d(days). The value must be an integer. Ex: 90m The value must be larger than timeout_express. Used to control the expiration time of lottery voucher. |
buyer_id* | string | merchant user's id |
customer.name* | string | User's name - Max. 40 chars - |
customer.phone* | string | User's phone |
customer.email* | string | User's email |
customer.identify.number* | string | User's identification number; - 11 digits if CPF or 14 digits if CNPJ - |
customer.identify.type* | string | User's identification type; - CPF or CNPJ - |
address.zip_code | string | zip code |
address.state | string | state |
address.city | string | city |
address.street_number | string | street number |
address.street | string | street |
website_url | string | merchant website URL - Max. 128 chars - |
# Responses
200 | submit successfully |
{
"code": "10000",
"msg": "Success",
"trade_no": "2022010106532400030",
"out_trade_no": "202201010354003",
"web_url": "",
"barcode": "10499647359216218774123156548721787200000011649",
"bank_no": "10850221",
"pay_url": "https://checkout-testv2.transfersmile.com/checkout?prepay_id=T3c0bUM5VDdQc1M4MThjeDlEVHBiZG5yNEc4V0hBZ3pEMlY2d3A0N2F6UT0=-B20807a4",
"trade_status": "PROCESSING"
}
400 | duplicate out_trade_no |
{
"code": "40002",
"msg": "Business Failed",
"sub_code": "duplicate-out_trade_no",
"sub_msg": "out_trade_no is duplicate"
}
TIP
User payment tips
Users only need to use the value of bank_no to finish payment at loterica store.
Providing a locator could help the user to find a store faster. Can link it to https://www.google.com/maps/search/loterias/ (opens new window)
# Example
curl --location --request POST 'https://gateway-test.transfersmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
* "app_id": "162************38",
* "out_trade_no": "202201010354003",
* "method": "Lottery",
* "order_amount": "12.01",
* "order_currency": "BRL",
* "subject": "trade pay test",
* "content": "trade pay test conent",
* "notify_url": "http://merchant/callback/success",
"return_url": "https://www.merchant.com",
* "buyer_id": "buyer_0101_0001",
* "timestamp": "2022-01-01 03:54:01",
"timeout_express":"1c",
* "customer" : {
* "identify": {
* "type": "CPF",
* "number": "50284414727"
},
* "name": "Test User Name",
* "email": "[email protected]",
* "phone": "75991435892"
},
"address" : {
"zip_code": "38082365"
}
}'
TIP
Note: 162********38 is transfersmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.
WARNING
Please use your own app_id and generate your own authorization token when testing.