Detalhar transferência

🔽
GET urlServidor/v1/marketplace/establishments/transfers/id

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/establishments/transfers/id' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da transferência a detalhar.

✅ Exemplo de Resposta - 200 OK

{
    "recipient": {
        "account_number": "300543394162",
        "account_check_digit": "8",
        "establishment": {
            "id": 155085,
            "first_name": "EC Cobranças",
            "last_name": null,
            "document": "10068114001"
        },
        "marketplace": {
            "id": 26,
            "first_name": "Webhooks Integrações",
            "last_name": "API Integrações",
            "document": "60274849000185"
        },
        "representative": {
            "id": 63,
            "first_name": "EC Cobranças",
            "last_name": null,
            "document": "10068114001"
        },
        "type": "CHECKING"
    },
    "payer": {
        "account_number": "416947",
        "account_check_digit": "0",
        "establishment": {
            "id": 155100,
            "first_name": "Teste Sandbox",
            "last_name": "Solucoes",
            "document": "11299221000129"
        },
        "marketplace": {
            "id": 26,
            "first_name": "Webhooks Integrações",
            "last_name": "API Integrações",
            "document": "60274849000185"
        },
        "type": "CHECKING"
    },
    "_id": "68a65eba69af539aa8ac9faf",
    "type": "P2P",
    "status": "PENDING",
    "amount": 50000,
    "establishment_id": "155100",
    "gateway_key": "7ae2d5cc-478d-4b97-97e2-89810f22b33b",
    "gateway_authorization": "CELCOIN",
    "expected_at": "2025-08-20T23:48:10.927Z",
    "user": {
        "id": 187,
        "first_name": "EC - API Integrações",
        "last_name": null,
        "profile_id": 1
    },
    "history": [
        {
            "status": "CREATED",
            "created_at": "2025-08-20T23:48:10.927Z",
            "_id": "68a65eba69af539aa8ac9fb0"
        }
    ],
    "method": "OUT",
    "description": "TRANSFERÊNCIA P2P",
    "reprocessed": false,
    "created_at": "2025-08-20T23:48:10.945Z",
    "updated_at": "2025-08-20T23:48:10.945Z",
    "__v": 0
}

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`_id`	string	Sim	ID da transferência.
`type`	string	Sim	Tipo da transferência. Valores possíveis: `TED`, `P2P`, `PIX`, `WITHDRAW`.
`status`	string	Sim	Status atual da transferência. Valores possíveis: `CREATED`, `PENDING`, `PAID`, `FAILED`, `REFUNDED`, `CANCELED`, `PROCESSING`.
`amount`	number	Sim	Valor transferido em centavos.
`original_amount`	number	Não	Valor original da transferência em centavos (antes das taxas).
`establishment_id`	string	Sim	ID do estabelecimento vinculado à transferência.
`gateway_key`	string	Não	Código identificador da transferência no gateway.
`gateway_authorization`	string	Sim	Código de autorização do gateway.
`expected_at`	string	Não	Data prevista para conclusão da transferência.
`recipient`	object	Sim	Dados da conta recebedora. Inclui: <br> • `establishment` <br> • `marketplace` <br> • `representative` <br> • `document` <br> • `bank_code` <br> • `bank_ispb` <br> • `bank_name` <br> • `routing_number` <br> • `routing_check_digit` <br> • `account_number` <br> • `account_check_digit` <br> • `type` (`SAVING`, `CHECKING`, `PAYMENT`) <br> • `pix_key`.
`payer`	object	Sim	Dados da conta pagadora. Estrutura idêntica ao `recipient`.
`history`	array	Sim	Histórico de status da transferência. Cada item possui: <br> • `status` (`CREATED`, `PENDING`, `PAID`, `FAILED`, `REFUNDED`, `CANCELED`, `PROCESSING`) <br> • `created_at` (data e hora do registro) <br> • `_id`.
`method`	string	Sim	Direção da transferência. Valores: `IN` (entrada) ou `OUT` (saída).
`pixKey`	string	Não	Chave Pix utilizada (quando aplicável).
`end_to_end`	string	Não	Identificador único da transação (end-to-end Pix).
`description`	string	Não	Descrição da transferência.
`reprocessed`	boolean	Não	Indica se a transferência foi reprocessada.
`created_at`	string	Sim	Data de criação da transferência.
`updated_at`	string	Sim	Data da última atualização da transferência.
`fees`	number	Não	Valor total de taxas da transferência (em centavos).
`user`	object	Sim	Informações do usuário responsável. Estrutura: <br> • `id` (número) <br> • `first_name` (string) <br> • `last_name` (string) <br> • `profile_id` (número).

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.