v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB

Transferências

Iniciar pagamento Pix

post/v1/marketplace/banking/transfers/pix-init

Headers

mTLSstring required

Esta rota requer autenticação mTLS. Você deve enviar seu certificado de cliente (ex: --cert client.crt --key client.key).

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Request body

Tipo da chave Pix.

keystring

Chave Pix. Obrigatório quando o tipo não for HASH.

hash_codestring

Código copia e cola. Obrigatório quando o tipo for HASH.

Response

_idstring required

ID do pagamento.

typestring required

Tipo do pagamento.

statusstring required

Status do pagamento.

establishment_idstring required

ID do estabelecimento.

init_typestring required

Tipo de inicialização.

transaction_identificationstring nullable

Identificação da transação.

gateway_authorizationstring required

Gateway autorizador.

expected_atstring required

Data prevista.

pixKeystring required

Chave Pix.

methodstring required

Método do pagamento.

descriptionstring required

Descrição do pagamento.

init_idstring required

ID do init.

end_to_endstring required

End-to-end.

reprocessedboolean required

Reprocessado.

commission_idstring nullable

ID da comissão.

reversal_transaction_idstring nullable

ID da reversão.

transfer_id_fees_originstring nullable

ID da transferência de taxas de origem.

created_atstring required

Data de criação.

updated_atstring required

Data de atualização.

__vnumber required

Versão do documento.