Enviar Pagamento (CASH-OUT)

Sumário

Descrição #

Esta API tem por finalidade realizar um pagamento via PIX para outra instituição, onde o id de transação (TXID) é criado automaticamente.
No momento do onboarding, o cliente nos envia uma URL do webhook, e assim que a transação for confirmada pelo Banco Semear, nossa API realiza uma chamada de confirmação ao webhook informado.

Funcionamento #

Para realizar o pagamento (cash-out) é necessário realizar dois passos:

  • Consulta/Geração de token
  • Requisição de pagamento

Requisição de Pagamento (POST) #

Segue exemplo de requisição:

Endpoints #

  • Produção: https://api2.bancosemear.com.br/paas-management-api/v1/public/payments
  • Homologação: https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments
Opção 1 (através da chave) #
curl --location 'https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments' \
--header 'client_id: <CLIENT_ID>' \
--header 'token: <TOKEN>' \
--header 'access_token: <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chave": "+5511999999999",
    "valor": 1.00, 
    "descricao": "Cash-Out para ...",
    "verificaDocumentoBeneficiario": true,
    "documentoBeneficiario": "00000000000",
    "identificadortransacao": "SMO00001"
}'
Opção 2 (através da conta) #
curl --location 'https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments' \
--header 'client_id: <CLIENT_ID>' \
--header 'token: <TOKEN>' \
--header 'access_token: <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "valor": 0.99,
    "descricao": "Teste",
    "codAgenciaBeneficiario": "0001",
    "codInstituicaoBeneficiario": "00999999",
    "nroContaBeneficiario": "00000000",
    "tipoContaBeneficiario": "CACC",
    "nomeBeneficiario": "teste",
    "documentoBeneficiario": "00000000000"
    "identificadortransacao": "SMO00001"
}'

Parâmetros de Requisição #

Cabeçalho #
  • Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON
  • client_id: ID de cliente usado para encaminhar a requisição ao gateway de APIs
  • access_token: Token recebido após executar o método oAuth
  • token: Payload JSON criptografado com uma chave pública codificado em base64 (Gerado no passo anterior, Consulta/Geração de token)

Corpo #
Opção 1 #
  • Chave: chave PIX de quem vai receber.
  • valor: valor a ser enviado.
  • descricao: Descrição para a transação realizada.
  • verificaDocumentoBeneficiario: Flag de controle que determina se valida ou não o documento do beneficiário enviado na requisição. (Caso false ou null, não é necessário o envio da propriedade documentoBeneficiario).
  • documentoBeneficiario: Documento de quem ira receber o pagamento, pode ser CPF ou CNPJ.
  • identificadortransacao: Identificação única com no máximo 40 caracteres alfanuméricos, utilizado para controle do cliente.
Opção 2 #
  • valor: valor a ser enviado.
  • descricao: Descrição para a transação realizada.
  • codAgenciaBeneficiario: Código da agencia do beneficiário.
  • codInstituicaoBeneficiario: Código da instituição do beneficiário.
  • nroContaBeneficiario: Número da conta do beneficiário.
  • tipoContaBeneficiario: Tipo de conta do beneficiário (CACC – Conta Corrente, SLRY – Conta Salário, SVGS – Conta Poupança, TRAN – Conta Pagamento).
  • nomeBeneficiario: Nome de beneficiário que recebera o pagamento.
  • documentoBeneficiario: Documento de quem ira receber o pagamento.
  • identificadortransacao: Identificação única com no máximo 40 caracteres alfanuméricos, utilizado para controle do cliente.

Resposta #

Segue exemplo de resposta:

{
    "CorrelationId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "Mensagem": "Ordem de pagamento recebida com sucesso."
}

Parâmetros de Resposta #

Corpo (JSON) #
  • CorrelationId: Chave (Identificador) da transação realizada.
  • Mensagem: Mensagem para cada transação.

Assim que o pagamento for confirmado, o webhook cadastrado receberá a informação.

Parâmetros de Resposta do Webhook #

Envio “verificaDocumentoBeneficiario”: true com “documentoBeneficiario” incorreto. #

Resposta quando enviado a TAG “verificaDocumentoBeneficiario”: true, com o documento informado incorretamente na TAG “documentoBeneficiario”.
– Nas TAGs “DestinationDocument” e “Document” trazem a informação do documento enviado.

{
  "Environment": "Homolog",
  "Registration": "EnvioPixCashout",
  "Details": {
    "Account": "XXXXXXXXXX",
    "Type": "PAASCASHOUT",
    "Status": "COM ERRO",
    "Error": {
      "Code": "40018",
      "Detail": "Documento do beneficiário diferente do Documento da DICT."
    },
    "CorrelationId": "XXXXXXXXXXXX-XXXX-XXXX-XXXXXXXXXXX",
    "Pix": {
      "TxId": null,
      "DestinationKey": "XXXXXXXXXXXX-XXXX-XXXX-XXXXXXXXXXX",
      "EndToEnd": null,
      "Value": 0.71,
      "PaymentDate": null,
      "Description": "Teste",
      "DestinationDocument": "XXXXXXXXXXXXXX",
      "RejectionReasonCode": null,
      "RejectionReasonDescription": null,
      "IspbCode": null,
      "Beneficiary": {
        "IspbCode": null,
        "Agency": null,
        "DigitAgency": null,
        "Account": null,
        "Type": null,
        "Document": "XXXXXXXXXXXXXXX",
        "Name": null,
        "OperationCode": "SMO00001"
      }
    }
  }
}
What are your Feelings

Distribuído porBetterDocs

Scroll to Top