Create an Immediate Charge

curl --request POST \
  --url https://api.example.com/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "100.00",
  "expirationSeconds": 3600,
  "receiverKey": "+5511999999999",
  "txId": "TXabcdefghijklmno123456789",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "52998224725",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "transactionAmount": "150.00",
  "withdrawalAmount": "50.00"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/collections/immediate"

	payload := strings.NewReader("{\n  \"amount\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"52998224725\",\n  \"debtorName\": \"João da Silva\",\n  \"description\": \"Payment for order #12345\",\n  \"locationInformation\": {\n    \"categoryCode\": \"5411\",\n    \"merchantCity\": \"São Paulo\",\n    \"merchantName\": \"Loja ABC\",\n    \"postalCode\": \"01310-100\"\n  },\n  \"metadata\": {},\n  \"tags\": [\n    \"ecommerce\",\n    \"subscription\"\n  ],\n  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '100.00',
    expirationSeconds: 3600,
    receiverKey: '+5511999999999',
    txId: 'TXabcdefghijklmno123456789',
    additionalInfo: {customerId: '67890', orderId: '12345'},
    debtorDocument: '52998224725',
    debtorName: 'João da Silva',
    description: 'Payment for order #12345',
    locationInformation: {
      categoryCode: '5411',
      merchantCity: 'São Paulo',
      merchantName: 'Loja ABC',
      postalCode: '01310-100'
    },
    metadata: {},
    tags: ['ecommerce', 'subscription'],
    transactionAmount: '150.00',
    withdrawalAmount: '50.00'
  })
};

fetch('https://api.example.com/v1/collections/immediate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/collections/immediate"

payload = {
    "amount": "100.00",
    "expirationSeconds": 3600,
    "receiverKey": "+5511999999999",
    "txId": "TXabcdefghijklmno123456789",
    "additionalInfo": {
        "customerId": "67890",
        "orderId": "12345"
    },
    "debtorDocument": "52998224725",
    "debtorName": "João da Silva",
    "description": "Payment for order #12345",
    "locationInformation": {
        "categoryCode": "5411",
        "merchantCity": "São Paulo",
        "merchantName": "Loja ABC",
        "postalCode": "01310-100"
    },
    "metadata": {},
    "tags": ["ecommerce", "subscription"],
    "transactionAmount": "150.00",
    "withdrawalAmount": "50.00"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": "100.00",
  "createdAt": "2024-01-15T10:30:00Z",
  "expirationSeconds": 3600,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "receiverKey": "+5511999999999",
  "status": "ACTIVE",
  "txId": "TXN123456789",
  "updatedAt": "2024-01-15T10:30:00Z",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "52998224725",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "emv": "00020126580014br.gov.bcb.pix...",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

POST

collections

immediate

Create an Immediate Charge

curl --request POST \
  --url https://api.example.com/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "100.00",
  "expirationSeconds": 3600,
  "receiverKey": "+5511999999999",
  "txId": "TXabcdefghijklmno123456789",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "52998224725",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "locationInformation": {
    "categoryCode": "5411",
    "merchantCity": "São Paulo",
    "merchantName": "Loja ABC",
    "postalCode": "01310-100"
  },
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ],
  "transactionAmount": "150.00",
  "withdrawalAmount": "50.00"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/collections/immediate"

	payload := strings.NewReader("{\n  \"amount\": \"100.00\",\n  \"expirationSeconds\": 3600,\n  \"receiverKey\": \"+5511999999999\",\n  \"txId\": \"TXabcdefghijklmno123456789\",\n  \"additionalInfo\": {\n    \"customerId\": \"67890\",\n    \"orderId\": \"12345\"\n  },\n  \"debtorDocument\": \"52998224725\",\n  \"debtorName\": \"João da Silva\",\n  \"description\": \"Payment for order #12345\",\n  \"locationInformation\": {\n    \"categoryCode\": \"5411\",\n    \"merchantCity\": \"São Paulo\",\n    \"merchantName\": \"Loja ABC\",\n    \"postalCode\": \"01310-100\"\n  },\n  \"metadata\": {},\n  \"tags\": [\n    \"ecommerce\",\n    \"subscription\"\n  ],\n  \"transactionAmount\": \"150.00\",\n  \"withdrawalAmount\": \"50.00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '100.00',
    expirationSeconds: 3600,
    receiverKey: '+5511999999999',
    txId: 'TXabcdefghijklmno123456789',
    additionalInfo: {customerId: '67890', orderId: '12345'},
    debtorDocument: '52998224725',
    debtorName: 'João da Silva',
    description: 'Payment for order #12345',
    locationInformation: {
      categoryCode: '5411',
      merchantCity: 'São Paulo',
      merchantName: 'Loja ABC',
      postalCode: '01310-100'
    },
    metadata: {},
    tags: ['ecommerce', 'subscription'],
    transactionAmount: '150.00',
    withdrawalAmount: '50.00'
  })
};

fetch('https://api.example.com/v1/collections/immediate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/collections/immediate"

payload = {
    "amount": "100.00",
    "expirationSeconds": 3600,
    "receiverKey": "+5511999999999",
    "txId": "TXabcdefghijklmno123456789",
    "additionalInfo": {
        "customerId": "67890",
        "orderId": "12345"
    },
    "debtorDocument": "52998224725",
    "debtorName": "João da Silva",
    "description": "Payment for order #12345",
    "locationInformation": {
        "categoryCode": "5411",
        "merchantCity": "São Paulo",
        "merchantName": "Loja ABC",
        "postalCode": "01310-100"
    },
    "metadata": {},
    "tags": ["ecommerce", "subscription"],
    "transactionAmount": "150.00",
    "withdrawalAmount": "50.00"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": "100.00",
  "createdAt": "2024-01-15T10:30:00Z",
  "expirationSeconds": 3600,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "receiverKey": "+5511999999999",
  "status": "ACTIVE",
  "txId": "TXN123456789",
  "updatedAt": "2024-01-15T10:30:00Z",
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "debtorDocument": "52998224725",
  "debtorName": "João da Silva",
  "description": "Payment for order #12345",
  "emv": "00020126580014br.gov.bcb.pix...",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Account ID (UUID format)

Cuerpo

application/json

amount

string

requerido

Minimum string length: 1

Ejemplo:

"100.00"

expirationSeconds

integer<int64>

requerido

Rango requerido: x >= 1

Ejemplo:

3600

receiverKey

string

requerido

Minimum string length: 1

Ejemplo:

"+5511999999999"

txId

string

requerido

Minimum string length: 1

Ejemplo:

"TXabcdefghijklmno123456789"

additionalInfo

object

Show child attributes

Ejemplo:

{ "customerId": "67890", "orderId": "12345" }

debtorDocument

string

Ejemplo:

"52998224725"

debtorName

string

Ejemplo:

"João da Silva"

description

string

Ejemplo:

"Payment for order #12345"

locationInformation

object

Show child attributes

metadata

object

Show child attributes

Respuesta

Created

amount

string

requerido

Ejemplo:

"100.00"

createdAt

string<date-time>

requerido

Ejemplo:

"2024-01-15T10:30:00Z"

expirationSeconds

integer<int64>

requerido

Ejemplo:

3600

string

requerido

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

receiverKey

string

requerido

Ejemplo:

"+5511999999999"

status

string

requerido

Ejemplo:

"ACTIVE"

txId

string

requerido

Ejemplo:

"TXN123456789"

updatedAt

string<date-time>

requerido

Ejemplo:

"2024-01-15T10:30:00Z"

additionalInfo

object

Show child attributes

Ejemplo:

{ "customerId": "67890", "orderId": "12345" }

debtorDocument

string

Ejemplo:

"52998224725"

debtorName

string

Ejemplo:

"João da Silva"

description

string

Ejemplo:

"Payment for order #12345"

emv

string

Ejemplo:

"00020126580014br.gov.bcb.pix..."

locationUrl

string

Ejemplo:

"https://api.example.com/qr/550e8400"

metadata

object

Show child attributes

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Create an Immediate Charge

Autorizaciones

Encabezados

Cuerpo

Respuesta