Exibir Transferência

🔽
GET urlServidor/v1/marketplace/liquidations/id/payments/payment_id/transfer

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/liquidations/id/payments/payment_id/transfer' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

📎 Path Parameters

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da liquidação associada à transferência.
`payment_id`	string	Sim	ID do pagamento relacionado a esta transferência.

Exemplo de Response de sucesso.

{
    "_id": "0000c0e72b1f2399b8e00000",
    "type": "PIX",
    "status": "PAID",
    "amount": 100000,
    "expected_at": "2025-07-22T22:10:38.309Z",
    "gateway_key": "GATEWAY123",
    "liquidation_id": "6720c0e72b1f2399b8e00000",
    "gateway_authorization": "AUTH456",
    "lot_number": "789",
    "release_number": "456",
    "user": {
        "id": 1,
        "first_name": "Admin",
        "last_name": "User"
    },
    "payer": {
        "first_name": "Pagador",
        "document": "11122233344",
        "routing_number": "0001",
        "routing_check_digit": "2",
        "account_number": "12345",
        "account_check_digit": "6",
        "type": "CHECKING"
    },
    "recipient": {
        "first_name": "Destinatário",
        "document": "55566677788",
        "routing_number": "0001",
        "routing_check_digit": "2",
        "account_number": "67890",
        "account_check_digit": "1",
        "type": "CHECKING",
        "bank_code": "001",
        "bank_name": "Banco Teste",
        "bank_ispb": "12345678",
        "pix_key": "[email protected]"
    },
    "history": [
        {
            "_id": "6720c0e72b1f2399b8e99999",
            "status": "PAID",
            "created_at": "2025-07-22T22:10:38.309Z"
        }
    ],
    "created_at": "2025-07-22T22:10:38.309Z",
    "updated_at": "2025-07-22T22:10:38.309Z",
    "__v": 0
}

Obs: Em ambiente SANDBOX os dados da resposta serão sempre os mesmos, pois não é executado liquidações em SANDBOX.

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`recipient`	object	Sim	Informações do destinatário da transferência.
`recipient.first_name`	string	Sim	Nome do titular da conta do destinatário.
`recipient.document`	string	Sim	Documento do titular da conta (CPF/CNPJ).
`recipient.routing_number`	string	Sim	Número da agência bancária do destinatário.
`recipient.routing_check_digit`	string	Sim	Dígito verificador da agência bancária.
`recipient.account_number`	string	Sim	Número da conta bancária do destinatário.
`recipient.account_check_digit`	string	Sim	Dígito verificador da conta bancária.
`recipient.type`	string	Sim	Tipo de conta bancária. Enum: `[ CHECKING, SAVING ]`
`recipient.bank_code`	string	Sim	Código do banco do destinatário.
`recipient.bank_name`	string	Sim	Nome do banco do destinatário.
`recipient.bank_ispb`	string	Sim	Código ISPB do banco do destinatário.
`recipient.pix_key`	string	Sim	Chave Pix usada para a transferência (caso aplicável).
`payer`	object	Sim	Informações do pagador da transferência.
`payer.first_name`	string	Sim	Nome do titular da conta do pagador.
`payer.document`	string	Sim	Documento do titular do pagador (CPF/CNPJ).
`payer.routing_number`	string	Sim	Número da agência bancária do pagador.
`payer.routing_check_digit`	string	Sim	Dígito verificador da agência do pagador.
`payer.account_number`	string	Sim	Número da conta bancária do pagador.
`payer.account_check_digit`	string	Sim	Dígito verificador da conta do pagador.
`payer.type`	string	Sim	Tipo de conta bancária do pagador. Enum: `[ CHECKING, SAVING ]`
`_id`	string	Sim	Identificador único da transferência.
`type`	string	Sim	Tipo da transferência. Enum: `[ TED, P2P, PIX ]`
`status`	string	Sim	Status atual da transferência. <br>Enum: `[ PENDING, PAID, FAILED, REFUNDED, CANCELED ]`
`amount`	number	Sim	Valor da transferência em centavos.
`expected_at`	string (date-time)	Sim	Data/hora esperada para conclusão da transferência.
`gateway_key`	string	Sim	Chave identificadora da transferência no gateway de pagamento.
`liquidation_id`	string	Sim	ID da liquidação associada a esta transferência.
`gateway_authorization`	string	Sim	Código de autorização da transferência no gateway.
`lot_number`	string	Sim	Número do lote de processamento da transferência.
`release_number`	string	Sim	Número de liberação da transferência.
`user`	object	Sim	Informações do usuário que executou ou acompanhou a transferência.
`user.id`	number	Sim	ID do usuário.
`user.first_name`	string	Sim	Primeiro nome do usuário.
`user.last_name`	string	Sim	Sobrenome do usuário.
`history`	array	Sim	Histórico de alterações de status da transferência.
`history[].status`	string	Sim	Status registrado em determinado momento. Enum: `[ PENDING, PAID, FAILED, REFUNDED, CANCELED ]`
`history[].created_at`	string (date-time)	Sim	Data/hora em que o status foi registrado.
`history[]._id`	string	Sim	Identificador do registro de histórico.
`created_at`	string (date-time)	Sim	Data de criação do registro da transferência.
`updated_at`	string (date-time)	Sim	Data da última atualização do registro.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.