API Reference

Create BRL Payout order - Using Pix Key

post
https://api-test.beeteller.com/gtw/3.0/payout/#pixkey
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
float
required
Defaults to 1000.85

The gross amount you will receive after the customer pays the order

string
enum
required
Defaults to BRL

The currency from the value field

Allowed:
string
Defaults to your-reference

With up to 64 characters, this field is optional and allows you to provide an internal reference of your own.

string
required
Defaults to 874531

The 2FA code, it's generated using the TOTP algorithm and your secret.

receiver
object
required

Customer's data from the one who will receive the funds.

pixKey
object
required

The receiver's Pix Key details. He must be the owner of the informed account

string

Optional URL which we'll use to send you callbacks for the created order

string
Defaults to 44.31.89.173

Your customer's IP from his Device

date-time
Defaults to 2022-01-17 11:16:08.630407-03:00

The timestamp your customer has requested the order

string
Defaults to Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36

Your customer's browser agent from the requester device

Headers
string
required

Your token generated in authentication step. Using Bearer prefix

string
required
Defaults to 7c6adaa5-2eac-43d1-89d2-46a41cedbe22

A random key to avoid duplicated requests. We recommend that you use UUID v4 as key.

Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago