API docs by Redocly

Idea Gateway API (1.0.0)

Erros

A API usa códigos de status HTTP padrão para indicar o sucesso ou falha da chamada da API. O corpo da resposta será JSON no seguinte formato:

{
  "message": "Algo deu errado."
}

Autenticação

A autenticação é tratada no lado do cliente. O cliente precisa enviar detalhes de autenticação para vários endpoints para que o recurso possa ser obtido de forma correta, os detalhes precisam ser enviado no cabeçalho Authorization com um prefixo Basic e a sua chave de API (codificada em Base64) que recebeu no cadastro na plataforma.

basicAuth

Suponhamos que sua chave de API seja minha-chave-de-api. Você deverá enviar uma string codificada em Base64 no seguinte formato :minha-chave-de-api, mantenha o : (dois pontos) na string. O resultado final será algo parecido com o conteúdo abaixo.

Authorization: Basic Om1pbmhhLWNoYXZlLWRlLWFwaQ==
Security Scheme Type: HTTP
HTTP Authorization Scheme: basic

Conta Digital

Conta digital

Nova Conta

Cria uma nova conta digital.

Authorizations:
basicAuth
Request Body schema: application/json
name
required
string

Nome completo do titular da conta

gender
string
Enum: "M" "F"

Gênero / Sexo

birthDate
required
string <date>

Data de nascimento no formato ISO-8601.

email
required
string

Um e-mail válido.

password
string [ 8 .. 12 ] characters

Senha de acesso a conta digital. Caso não seja informado uma senha, o sitema criará uma senha randômica.

cpf
required
string

CPF válido

object
required
object
required
object
required
Array of objects (Account Document)

Lista de documentos

Responses

Request samples

Content type
application/json
{
  • "name": "Foo Bar",
  • "gender": "M",
  • "birthDate": "2019-08-24",
  • "email": "foo@bar.com",
  • "password": 12345678,
  • "cpf": 45576360044,
  • "rg": {
    },
  • "address": {
    },
  • "phone": {
    },
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "status": "doc_pending",
  • "docs": [
    ]
}

Atualizar Documento

Atualizar um documento enviado anteriormente

Authorizations:
basicAuth
path Parameters
accountNumber
required
string
Example: 138338

Número da conta

documentId
required
string
Example: 848172

ID do documento

Request Body schema: application/json
type
required
string
Enum: "cpf" "rg" "cnh" "proof_address"

Tipo de documento, CPF, RG, CNH ou Comprovante de Residência

fileFormat
string
Enum: "image/png" "image/jpeg" "application/pdf"

Formato do arquivo enviado

file
required
string <base64>

Conteúdo do arquivo em formato Base64

Responses

Request samples

Content type
application/json
{
  • "type": "cpf",
  • "fileFormat": "image/png",
  • "file": "iVBORw0KGgoAAAANSUhEUgAAAV4AAACWBAMAAABkyf1EAAAAG1BMVEXMzMyWlpacnJyqqqrFxcWxsbGjo6O3t7e+vr6He3KoAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAEcElEQVR4nO2aTW/bRhCGh18ij1zKknMkbbf2UXITIEeyMhIfRaF1exQLA/JRclslRykO+rs7s7s0VwytNmhJtsA8gHZEcox9PTs7uysQgGEYhmEYhmEYhmEYhmEYhmEYhmEYhmEYhmEYhmEYhmGYr2OWRK/ReIKI8Zt7Hb19wTcQ0uTkGh13bQupcw7gPOvdo12/5CzNtNR7xLUtNtT3CGBQ6g3InjY720pvofUec22LJPr8PhEp2OMPyI40PdwWUdronCu9yQpdPx53bQlfLKnfOVhlnDYRBXve4Ov+IZTeMgdedm0NR+xoXJeQvdJ3CvziykSukwil16W/Oe7aGjIjqc/9ib4jQlJy0uArtN4A0+cvXFvDkmUJ47sJ1Y1ATLDNVXZkNPIepQzxy1ki9fqiwbUj/I+64zxWNzyZnPuhvohJ9K70VvXBixpcu2SAHU+Xd9EKdEJDNpYP3AQr3bQSpPQ6Y6/4dl1z7ZDbArsszjA7L0g7ibB0CDcidUWVoErvIMKZh2Xs0LUzcLW6V5NfiUgNEbaYmAVL6bXl0nJRc+1S72ua/D/cTjGPlQj7eUqd7A096rYlRjdPYlhz7VIvxpVG3cemDKF+WAwLY/6XelOZKTXXzsC4xvDjjtSN6kHLhLke6PrwM8h1raf40qjrGO7H9aTEbduucjS04ZrYU/4iuS5Z2Hdt0rvCLFdmLEXcU30AGddST62o+sLcf5l6k7CP+ru4pLYqX/VFyxbm/utQbx/r22ZEbTb2f5I2kns1Y1OQR8ZyofX+TjJxj1Rz7QQVnf1QzR26Oth0ueJVYcRP6ZUPac/Rx/5M6ixO1dhSrT3Y1DpiYmx3tF4ZUdpz9LD/dSg9PXES0LB71BwcGjKROuV28lnvnv7HHJsezheBGH5+X2CfSfRbMKW+5aGs3JFjMrjGibJc0S7TJzqjHrh2hDybj9XRXNZa89Aro55XBdbW5wti2c/5WJ7jJ1RolVUn/HWpb0I58Tziup6Rx7Dm2hnbRP1GM9PW/NFmQ4PtVRVN63Wvxfmu5sowDMMwDMMwDMMwDMMwDMMwDMMwzL+CpT//F/6beoV8zb2Jmt4Qryx6lTUCsENQ75HOkhXAO3EPVgyQtKtUy3C/e+FJg17Zjnew1Xrdb9InbG4WqfUAftG+WhLwPVyfg536+MU7m4C1CMk4ZznpXZzDYI1PDL2nS1hpvc5cNd7E2sJg05Fe7/7d3Fln8Cvc3bwB616auxsKl4WPghjemHrDqyDWeu1UNW5s2btPnSQ75oOdunEwWazfwgVG0kqluYCM9OIjWOGnfA2b9G4Ha63XKpvQ8perTvTifJNhi6+WMWmi7smEZf6G8MmhlyGq+NqP8GV84TLuJr7UIQVx+bDEoEpRZIz42gs40OuN4Mv8hXzelV7KX1isH+ewTWckikyVv+CfHuqVF7I16gN0VKypX6wPsE+zFPzkinolU9UH8OMGvSpnZqKsv13p/RsMun6X5x/y2LeAr8O66lsBwzBMP/wJfyGq8pgBk6IAAAAASUVORK5CYII="
}

Response samples

Content type
application/json
{
  • "id": 848192,
  • "type": "cpf"
}

Token de Autenticação

Obtenção do token de autenticação para realização de transferência de valores.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "token": "b5507016-7da2-4777-a161-1e8042a6a377",
  • "expiresIn": 600
}

Transferência

Transferência bancária de valores.

OBSERVAÇÃO

Para realização da transferência é necessário ter um token de authenticação (authToken), que pode ser obtido fazendo uma requisição para a rota de obtenção de token.

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
number

O valor a ser transferido em centavos. Ex.: R$ 1,00 = 100

holderCpf
required
string

CPF do titular da conta destino do dinheiro.

authToken
string <uuid>

Token de autenticação.

Responses

Request samples

Content type
application/json
{
  • "amount": 100,
  • "holderCpf": "76430473910",
  • "authToken": "007431a5-f913-4a19-8dd6-9350bb7229f6"
}

Response samples

Content type
application/json
{
  • "message": "Saldo insuficiente."
}

Boleto Bancário

Boleto Bancário

Confirmação de pagamento Webhook

Disparo de confirmação de pagamento de Boleto. Para utilização deste serviço é necessário que nos seja informado uma url para que possamos cadastrar em nosso sistema de disparos.

Request Body schema: application/json
object

informações do envento a ser disparado

Responses

Request samples

Content type
application/json
{
  • "event": {
    }
}

Novo Boleto

Gerar um novo boleto.

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
string

O valor do boleto em centavos. Ex.: R$10 = 1000

dueDate
required
string

Data de vencimento do boleto no formato YYYY-MM-DD.

required
object

Dados do pagador.

customCode
string

Código do cliente, um código personalizado que o cliente pode usar para consultas futuras.

instructions
string

Instruções

Responses

Request samples

Content type
application/json
{
  • "amount": "1000",
  • "dueDate": "2020-12-05",
  • "payerData": {
    },
  • "customCode": "order123",
  • "instructions": "Após o pagamento, consulte seu saldo no aplicativo"
}

Response samples

Content type
application/json
{}

Download de Boleto

Realizar download de um boleto gerado anteriormente através do ID.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 8a9d35b5-33d9-4a94-b580-218ab4188fe8

Responses

Response samples

Content type
application/json
{
  • "message": "Boleto não encontrado ou não disponível."
}

Pix

Pix

Confirmação de pagamento Webhook

Disparo de confirmação de pagamento de PIX. Para utilização deste serviço é necessário que nos seja informado uma url para que possamos cadastrar em nosso sistema de disparos.

Request Body schema: application/json
object

informações do envento a ser disparado

Responses

Request samples

Content type
application/json
{
  • "event": {
    }
}

Pesquisa por customCode

Pesquisa transação por customCode.

Authorizations:
basicAuth
query Parameters
customCode
string

customCode da transação.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Solicitar Pix

Solicitar geração de código Pix.

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
number

O valor do pix em centavos. Ex.: R$10 = 1000

customCode
string

Código do cliente, um código personalizado que o cliente pode usar para consultas futuras.

object (Customer)
instructions
string

Instruções de pagamento para o pix.

paymentId
string

Id do pagamento, o mesmo é gerado de forma automática, caso queira passar manualmente é possivel por este campo.

expire
number

Tempo de expiração para o pix

Responses

Request samples

Content type
application/json
{
  • "amount": "1000",
  • "customCode": "order123",
  • "customer": {
    },
  • "instructions": "Após o pagamento, consulte seu titulo 1 no app.",
  • "paymentId": "00000hipercapmogi121640000300221295",
  • "expire": 3600
}

Response samples

Content type
application/json
{
  • "id": "ae64fd9e-33f7-4ad0-950e-88ff394a01c9",
  • "amount": 1000,
  • "qrCode": "00020126580014br.gov.bcb.pix01366b4baa8d-f70f-43cf-8593-631c34fff65752040000530398654045.005802BR5907TYESTE26007SO PAUA62270523000000000500000000002706304D0D9",
  • "status": "pending",
  • "gatewayId": "4"
}

Pix Estático (Infra)

Solicitar geração de código Pix com QRCode estático. (Infra)

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
string

O valor do pix em centavos. Ex.: R$10 = 1000

customCode
string

Código do cliente, um código personalizado que o cliente pode usar para consultas futuras.

receiverName
string

Nome de quem vai receber

receiverCity
string

Cidade de quem vai receber

instructions
string

Intruções

Responses

Request samples

Content type
application/json
{
  • "amount": "1000",
  • "customCode": "order123",
  • "receiverName": "Idea Maker Solution",
  • "receiverCity": "Sao Paulo",
  • "instructions": "Após o pagamento, consulte seu saldo no aplicativo"
}

Response samples

Content type
application/json
{
  • "id": "RTSiOsXnFBWKCMlmkA2EdjqIe",
  • "qrCode": "00020101021126360014BR.GOV.BCB.PIX01141379439900017152040000530398654040.015802BR5925Idea Maker Meios de Pagam6015Santana de Parn62290525RTSiOsXnFBWKCMlmkA2EdjqIe63041DBB"
}

Pix Estático

Solicitar geração de código Pix com QRCode estático.

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
string

O valor do pix em centavos. Ex.: R$10 = 1000

customCode
string

Código do cliente, um código personalizado que o cliente pode usar para consultas futuras.

instructions
string

Intruções

Responses

Request samples

Content type
application/json
{
  • "amount": "1000",
  • "customCode": "order123",
  • "instructions": "Após o pagamento, consulte seu saldo no aplicativo"
}

Response samples

Content type
application/json
{
  • "id": "RTSiOsXnFBWKCMlmkA2EdjqIe",
  • "qrCode": "00020101021126360014BR.GOV.BCB.PIX01141379439900017152040000530398654040.015802BR5925Idea Maker Meios de Pagam6015Santana de Parn62290525RTSiOsXnFBWKCMlmkA2EdjqIe63041DBB"
}

Cancelamento de Pix em massa

Solicitar cancelamento de Pix em massa

Authorizations:
basicAuth
Request Body schema: application/json
customCodes
required
Array of arrays

Códigos dos clientes, um código personalizado que o cliente pode usar para consultas futuras.

Responses

Request samples

Content type
application/json
{
  • "customCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Não foi possível processar o cancelamento."
}

Cancelamento de Pix por ID

Solicitar cancelamento de Pix por ID.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 8a9d35b5-33d9-4a94-b580-218ab4188fe8

ID da transação.

Responses

Response samples

Content type
application/json
{
  • "message": "Pix não encontrado."
}

Reabilitação do QrCode

Solicitar reabilitação de código Pix com QRCode estático.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 8a9d35b5-33d9-4a94-b580-218ab4188fe8

ID da transação.

Request Body schema: application/json
customCode
required
string

Código do cliente, um código personalizado que o cliente pode usar para consultas futuras.

Responses

Request samples

Content type
application/json
{
  • "customCode": "order123"
}

Response samples

Content type
application/json
{
  • "id": "RTSiOsXnFBWKCMlmkA2EdjqIe",
  • "amount": "1000",
  • "status": "pending",
  • "qrCode": "00020101021126360014BR.GOV.BCB.PIX01141379439900017152040000530398654040.015802BR5925Idea Maker Meios de Pagam6015Santana de Parn62290525RTSiOsXnFBWKCMlmkA2EdjqIe63041DBB"
}

Encontrar Pix por ID (adicionar Metadata)

Encontrar Pix por ID e adicionar Metadata.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 8a9d35b5-33d9-4a94-b580-218ab4188fe8

ID da transação.

Request Body schema: application/json
customCode
required
string

Código do cliente, um código personalizado que o cliente pode usar para consultas futuras.

Responses

Request samples

Content type
application/json
{
  • "customCode": "order123"
}

Response samples

Content type
application/json
{
  • "id": "RTSiOsXnFBWKCMlmkA2EdjqIe",
  • "amount": "1000",
  • "status": "pending",
  • "provider": "gerencianet",
  • "customer": {
    },
  • "metadata": {
    }
}

Pesquisa por ID

Pesquisa uma trancação por ID.

Authorizations:
basicAuth
path Parameters
id
required
string

ID da transação.

Responses

Response samples

Content type
application/json
{
  • "id": "ae64fd9e-33f7-4ad0-950e-88ff394a01c9",
  • "amount": 1000,
  • "status": "pending",
  • "provider": "gerencianet",
  • "customer": {
    },
  • "metadata": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Estorno

Solicita estorno de uma transação Pix.

Authorizations:
basicAuth
Request Body schema: application/json
amount
string

O valor do reembolso em centavos. Ex.: R$10 = 1000. Se não informado o valor total da transação será estornado.

Responses

Request samples

Content type
application/json
{
  • "amount": "1000"
}

Response samples

Content type
application/json
{
  • "id": "b913dda7-f6d6-45b3-b687-102b05a3e106",
  • "amount": 100,
  • "status": "string",
  • "provider": "gerencianet",
  • "customer": {
    },
  • "capturedDate": "2021-01-27T14:43:37.706Z",
  • "metadata": {
    },
  • "createdAt": "2021-01-27T14:43:37.706Z"
}

Cashout

Envio de valores para contas bancárias ou chaves Pix.

Authorizations:
basicAuth
Request Body schema: application/json
One of
amount
required
string

O valor do reembolso em centavos. Ex.: R$10 = 1000. Se não informado o valor total da transação será estornado.

required
object
customCode
string

Responses

Request samples

Content type
application/json
Example
{
  • "amount": "1000",
  • "favored": {
    },
  • "customCode": "codigo-personalizado"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "pending"
}

Cartão de Crédito

Notificação Webhook

Um POST para a URL cadastrada em nossos sistema será enviado toda vez que houver uma alteração de status na transação

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "event": {
    }
}

Pesquisa por ID

Pesquisa uma trancação por ID.

Authorizations:
basicAuth
path Parameters
id
required
string

ID da transação.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "paid",
  • "provider": "cielo",
  • "customer": {
    },
  • "refundedDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 500,
  • "capturedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Estorno de Transação

Faz um cancelamento / estorno de uma transação. Ao fazer o envio a solicitação é colocada em processamento para refund, retornando como refund_requested, tendo até 24h para o refund ser concluído.

Authorizations:
basicAuth
path Parameters
id
required
string

ID da transação.

Request Body schema: application/json
amount
integer

Valor do estorno.

Responses

Request samples

Content type
application/json
{
  • "amount": 500
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "refund_requested",
  • "provider": "cielo",
  • "customer": {
    },
  • "refundedDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 500,
  • "capturedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Pesquisa por customCode

Pesquisa uma transação por customCode.

Authorizations:
basicAuth
query Parameters
customCode
required
string

customCode da transação.

providerName
string

providerName da transação, o mesmo só deve ser usado se em conjunto com customCode.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cobrar cliente

Faz uma cobrança através de cartão de crédito.

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
string

O valor da transacão em centavos. Ex.: R$10 = 1000

customCode
string

Código personalizado da plataforma.

isGift
boolean

Define se a compra é um presente ou não.

required
object (CustomerCreditCardRequest)
required
object
softDescriptor
string

Texto impresso na fatura bancaria comprador.

Responses

Request samples

Content type
application/json
{
  • "amount": "1000",
  • "customCode": "my-code",
  • "isGift": false,
  • "customer": {
    },
  • "card": {
    },
  • "softDescriptor": "my-code"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "paid",
  • "provider": "cielo",
  • "customer": {
    },
  • "capturedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Cartão de Débito

Notificação Webhook

Um POST para a URL cadastrada em nossos sistema será enviado toda vez que houver uma alteração de status na transação

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "event": {
    }
}

Pesquisa por ID

Pesquisa uma trancação por ID.

Authorizations:
basicAuth
path Parameters
id
required
string

ID da transação.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "paid",
  • "provider": "cielo",
  • "customer": {
    },
  • "refundedDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 500,
  • "capturedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Estorno de Transação

Faz um cancelamento / estorno de uma transação.

Authorizations:
basicAuth
path Parameters
id
required
string

ID da transação.

Request Body schema: application/json
amount
integer

Valor do estorno.

Responses

Request samples

Content type
application/json
{
  • "amount": 500
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "refunded",
  • "provider": "cielo",
  • "customer": {
    },
  • "refundedDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 500,
  • "capturedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Pesquisa por customCode

Pesquisa uma transação por customCode.

Authorizations:
basicAuth
query Parameters
customCode
string

customCode da transação.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cobrar cliente

Faz uma cobrança através de cartão de débito. Caso a propriedade returnUrl não seja informada e o webhook estiver configurado para o cliente, uma notificação será enviada para o webhook configurado. Veja a seção de notificação para mais detalhes.

Authorizations:
basicAuth
Request Body schema: application/json
amount
required
string

O valor da transacão em centavos. Ex.: R$10 = 1000

customCode
string

Código personalizado da plataforma.

isGift
boolean

Define se a compra é um presente ou não.

required
object (CustomerCreditCardRequest)
required
object
returnUrl
string

URL para pagamento através do browser.

Responses

Request samples

Content type
application/json
{
  • "amount": "1000",
  • "customCode": "my-code",
  • "isGift": false,
  • "customer": {
    },
  • "card": {
    },
  • "returnUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "paid",
  • "provider": "cielo",
  • "customer": {
    },
  • "refundedDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 500,
  • "capturedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "redirectUrl": "string"
}

Consulta de transações

Consultar transações no gateway

Consultar transação

Retorna informações da transação

  • O id a ser informado pode ser o id do cliente ou id de transação do gateway
Authorizations:
basicAuth
path Parameters
id
required
string
Example: order1234 OR 8a9d35b5-33d9-4a94-b580-218ab4188fe8

Responses

Response samples

Content type
application/json
Example
{
  • "id": "ae64fd9e-33f7-4ad0-950e-88ff394a01c9",
  • "customCode": "order123",
  • "amount": 1000,
  • "amountPaid": 1000,
  • "status": "paid",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "provider": "pinbank",
  • "type": "bankslip",
  • "customer": {
    },
  • "metadata": {
    }
}

Geral

Consultar por Código

Realiza uma consulta de status para o(s) pagamento(s) de boleto com o customCode.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consulta por ID

Realiza uma consulta de status para o pagamento com o ID informado.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 100,
  • "status": "pending",
  • "provider": "gerencianet",
  • "metadata": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Código de Barras

API para pagamento de código de barras.

Pagar

Pagar uma conta de boleto com código de barras.

Authorizations:
basicAuth
Request Body schema: application/json
amount
number

O valor do boleto em centavos. Ex.: R$10 = 1000

barcode
string

Código de barras a ser pago.

customCode
string

Código personalizado da aplicação.

Responses

Request samples

Content type
application/json
{
  • "amount": 1000,
  • "barcode": "0000000000000000000000000000000000",
  • "customCode": "codigo-personalizado"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "status": "pending"
}