- Core
- oAuth
- account
- notifications
- account/me
- account/balance
- account/balances
- account/statement
- account/last_statement
- account/products
- account/send_phone_code
- account/register (cpf)
- account/register (cnpj)
- account/verifie_phone_code
- account/upload_docs
- account/transactional_password
- account/check_document
- account/profile_photo
- account/rating
- account/transactional_password
- account/verifie_transactional_password
- account/phone
- account/phone/validate
- account/password
- account/tooltip
- account/profile_photo
- account/country
- account/report
- account/active
- health
- id
- version
- Ultils
- Representative
- validations
- banking
- OpenBanking
- Autenticação
- Conta
- PIX
- Transferências
- Boletos
- Pagamentos de Títulos
- Webhook
- HealthCheckGET
Iniciando e Confirmando o PIX
Production
https://api.valut.app/openbank/v1
Production
https://api.valut.app/openbank/v1
POST
https://api.valut.app/openbank/v1
Requisição
Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/json
amount
integer
requerido
key_type
string
requerido
key
string
requerido
external_id
string
requerido
Exemplo
{
"amount": 65,
"key_type": "document", //document, phone, email, randomKey, a1c0ccbf-0374-4ed6-a09b-649fbba13584
"key": "01234567890",
"external_id": "{{$guid}}"
}
Exemplos de Requisição
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.valut.app/openbank/v1/pix/payments' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 65,
"key_type": "document", //document, phone, email, randomKey, a1c0ccbf-0374-4ed6-a09b-649fbba13584
"key": "01234567890",
"external_id": "{{$guid}}"
}'
Respostas
🟢200200 OK
application/json
Body
pix_id
string
requerido
endToEndId
string
requerido
amount
integer
requerido
tax_amount
integer
requerido
status
string
requerido
created_at
string
requerido
external_id
string
requerido
receiver
object
requerido
ipsb
string
requerido
bank_name
string
requerido
branch
string
requerido
account_number
string
requerido
account_type
string
requerido
document
string
requerido
document_type
string
requerido
name
string
requerido
trade_name
string
requerido
Exemplo
{
"pix_id": "11112222-ce91-4654-8f97-f4955d5e0b6a",
"endToEndId": "E7102786620220713142814756293322",
"amount": 101,
"tax_amount": 0,
"status": "processing",
"created_at": "2022-07-13T11:28:15.221904-03:00",
"external_id": "22228b26-4c53-44e4-b945-6b5fa8727f0b",
"receiver": {
"ipsb": "18236120",
"bank_name": "NU PAGAMENTOS - IP",
"branch": "0001",
"account_number": "0123455",
"account_type": "ContaPagamento",
"document": "01234567890",
"document_type": "CPF",
"name": "string",
"trade_name": "string"
}
}
Modificado em 2024-12-09 08:26:00