Get Subaccount Payout
Consulta um saque desta subconta: se o PIX saiu, se ainda está em processamento, ou se falhou e o valor voltou para a subconta.
payoutId aceita qualquer um dos identificadores que você tem do saque, e todos devolvem a mesma resposta:
- o
withdrawal.idou ocode(TURBO-...) da resposta dePOST /v1/subaccounts/{id}/payout. Ocodetambém vem no202e no webhooksubaccount.payout; saq_idem_seguido da suaidempotencyKey, para saques feitos com ela. É o caminho de quem tomou um timeout e ficou sem resposta nenhuma;- o
payoutId(saq_...), que é orefIddo lançamentopayoutno extrato da subconta; - o código
SUB-...de um saque recusado antes de chegar ao banco, que aparece no lançamento de estorno do extrato.
status:
completed: o PIX saiu e o banco confirmou.processing: o saque ainda não terminou. Inclui o saque em verificação (o202da chamada de saque) e o que acabou de ser pedido, que pode vir comwithdrawalIdecodeaindanull. O dinheiro PODE ter saído: não repita o saque, consulte de novo mais tarde.failed: nada foi enviado, efailureReasondiz o motivo. Comreversedtrue, o valor já voltou para a subconta (o estorno está no extrato, na data dereversedAt) e dá para sacar de novo com umaidempotencyKeynova. Comreversedfalse, o estorno ainda não aconteceu: fale com o suporte.
Valores em centavos: amountCents é o bruto debitado da subconta (o mesmo do pedido de saque), feeCents é o markup de saque da subconta, platformFeeCents é a taxa do saque e netAmountCents é o que a chave PIX recebe. Os dois últimos são null quando o saque não chegou a ser montado para envio.
pixKey volta mascarada, como em GET /v1/payouts. recipientName e recipientBankName só aparecem em saque que não falhou.
Permissão: subcontas.gerenciar ou subcontas.sacar. A chave que só faz repasses consegue acompanhar os repasses que dispara.
Saque de outra subconta, de outra conta ou de outro ambiente responde 404. Saque de subconta só existe em chave live, então uma chave de sandbox sempre recebe 404 aqui.
Authorizations
Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).
Path Parameters
ID da subconta (sacc_ + 32 hex).
O saque: saq_idem_<sua idempotencyKey>, saq_..., TURBO-..., SUB-... ou o withdrawal.id (24 hex) da resposta do saque.
Response
O saque, no estado atual.
O refId do lançamento payout no extrato da subconta.
O mesmo withdrawal.id da resposta do saque. null enquanto o saque ainda está sendo criado.
TURBO-... ou, no saque recusado antes do banco, SUB-....
completed, processing, failed O valor voltou para a subconta.
Bruto debitado da subconta.
Markup de saque da subconta, dentro do bruto.
Taxa do saque.
O que a chave PIX recebe.
Chave de destino, mascarada.
Identificador do PIX no banco. É por ele que quem recebeu acha o crédito.
Só com status failed.
Quando a subconta foi debitada.

