Docs
PTENES Site Criar conta

TransferênciasCriar Transferência

Criar Transferência

POST/v1/transferhttps://api.securitypag.com

Autenticação: Bearer · chave de saque

Para criar uma transferência, utilize a rota v1/transfer. Essa rota é compatível com transferências via PIX.

Importante: Em vez de inserir o token padrão para realizar a requisição, você deve inserir a Credencial de Saque via API, disponível na página de Integrações, no card "Credenciais de Saque via API".

Corpo da requisição

Enviado em JSON.

  • amountintegerobrigatório

    Valor da transferência em centavos. Exemplo: R$ 1,00

  • methodstringobrigatório

    Método de transferência. Atualmente suportado: PIX.

  • externalRefstring

    Referência externa atribuída pelo integrador.

  • notificationUrlstring

    URL para onde os webhooks da transferência serão enviados.

  • pixobjectobrigatório2 campos

    Dados da transferência via Pix.

    • pixKeystringobrigatório

      Chave Pix do recebedor.

    • pixKeyTypestringobrigatório

      Tipo da chave Pix (CPF, CNPJ, EMAIL, PHONE, EVP, COPYPASTE).

Respostas

200Objeto de resposta retornado em caso de sucesso na criação ou atualização da transferência.
  • idstring

    Identificador único da transferência.

  • amountinteger

    Valor da transferência em centavos.

  • methodstring

    Método de transferência utilizado (ex: PIX).

  • currencystring

    Código da moeda da transferência (ex: BRL).

  • statusstring

    Status atual da transferência (IN_QUEUE, IN_ANALYSIS, APPROVED, PROCESSING, COMPLETED, REFUSED, FAILED).

  • messagestring

    Mensagem adicional associada ao status da transferência.

  • externalRefstring

    Referência externa atribuída pelo integrador.

  • notificationUrlstring

    URL configurada para recebimento de notificações da transferência.

  • approvedAtstring

    Data e hora em que a transferência foi aprovada.

  • refusedAtstring

    Data e hora em que a transferência foi recusada.

  • cancelledAtstring

    Data e hora em que a transferência foi cancelada.

  • paidAtstring

    Data e hora em que a transferência foi efetivamente paga.

  • createdAtstring

    Data e hora de criação da transferência.

  • updatedAtstring

    Data e hora da última atualização da transferência.

  • dataobject4 campos

    Dados específicos do método de transferência.

    • methodstring

      Método de transferência relacionado aos dados retornados.

    • pixKeystring

      Chave Pix utilizada na transferência, quando o método for PIX.

    • e2estring

      End to End ID da transferência Pix, quando o método for PIX.

    • pixKeyTypestring

      Tipo da chave Pix (CPF, CNPJ, EMAIL, PHONE, EVP).

400Erro de validação ao criar a transferência.

Algo errado nesta página? Fale com o time