Obter repasse PIX

gethttps://sandbox-api.rebornpay.io/v1/payouts/{pixTransactionId}Auth obrigatória

Retorna o repasse PIX do seller autenticado pelo `pixTransactionId` da criação. O schema é o mesmo de `POST /v1/payouts/pix`, incluindo `status`, `paidAmountCents`, `pendingAmountCents`, `gowdEndToEndId`, `recipient` e `batchTransactions`. Em um saque para chave PIX, `recipient` traz o titular e a conta bancária resolvidos no DICT. Status possíveis: `AWAITING_APPROVAL`, `PENDING`, `PAID`, `PARTIALLY_PAID`, `ERROR`, `REJECTED`.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Path Parameters

pixTransactionIdstringrequired

UUID do repasse retornado em pixTransactionId

Responses

200Dados do repasse

pixTransactionIdstring · uuidrequired

statusstringrequired

amountinteger · int64required

currencystringrequired

destinationKeystringoptional

destinationKeyTypestringoptional

bankAccountobjectoptional

ispbstringoptional

bankNumberstringoptional

branchNumberstringrequired

accountNumberstringrequired

accountTypestringrequired

recipientobjectoptional

Titular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.

namestringoptional

Nome do titular da chave

Example: Joao da Silva

documentTypestringoptional

Tipo do documento do titular

Example: CPF

documentNumberstringoptional

Documento mascarado do titular

Example: ***456789-**

bankobjectoptional

Conta bancária associada à chave PIX no DICT

ispbstringoptional

ISPB da instituição

Example: 12345678

namestringoptional

Nome da instituição

Example: Banco Exemplo S.A.

bankNumberstringoptional

Código COMPE da instituição

Example: 237

branchNumberstringoptional

Agência

Example: 0001

accountNumberstringoptional

Número da conta

Example: 1234567

accountTypestringoptional

Tipo da conta informado pelo provedor

Example: CHECKING_ACCOUNT

descriptionstringoptional

createdAtstring · date-timerequired

requiresApprovalbooleanrequired

idempotencyKeystringoptional

paidAmountCentsinteger · int64optional

pendingAmountCentsinteger · int64optional

gowdEndToEndIdstringoptional

errorMessagestringoptional

batchTransactionsarrayrequired

sequenceinteger · int32optional

statusstringoptional

amountCentsinteger · int64optional

endToEndIdstringoptional

401API Key ausente ou inválida

pixTransactionIdstring · uuidrequired

statusstringrequired

amountinteger · int64required

currencystringrequired

destinationKeystringoptional

destinationKeyTypestringoptional

bankAccountobjectoptional

ispbstringoptional

bankNumberstringoptional

branchNumberstringrequired

accountNumberstringrequired

accountTypestringrequired

recipientobjectoptional

Titular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.

namestringoptional

Nome do titular da chave

Example: Joao da Silva

documentTypestringoptional

Tipo do documento do titular

Example: CPF

documentNumberstringoptional

Documento mascarado do titular

Example: ***456789-**

bankobjectoptional

Conta bancária associada à chave PIX no DICT

ispbstringoptional

ISPB da instituição

Example: 12345678

namestringoptional

Nome da instituição

Example: Banco Exemplo S.A.

bankNumberstringoptional

Código COMPE da instituição

Example: 237

branchNumberstringoptional

Agência

Example: 0001

accountNumberstringoptional

Número da conta

Example: 1234567

accountTypestringoptional

Tipo da conta informado pelo provedor

Example: CHECKING_ACCOUNT

descriptionstringoptional

createdAtstring · date-timerequired

requiresApprovalbooleanrequired

idempotencyKeystringoptional

paidAmountCentsinteger · int64optional

pendingAmountCentsinteger · int64optional

gowdEndToEndIdstringoptional

errorMessagestringoptional

batchTransactionsarrayrequired

sequenceinteger · int32optional

statusstringoptional

amountCentsinteger · int64optional

endToEndIdstringoptional

404Repasse não encontrado

pixTransactionIdstring · uuidrequired

statusstringrequired

amountinteger · int64required

currencystringrequired

destinationKeystringoptional

destinationKeyTypestringoptional

bankAccountobjectoptional

ispbstringoptional

bankNumberstringoptional

branchNumberstringrequired

accountNumberstringrequired

accountTypestringrequired

recipientobjectoptional

Titular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.

namestringoptional

Nome do titular da chave

Example: Joao da Silva

documentTypestringoptional

Tipo do documento do titular

Example: CPF

documentNumberstringoptional

Documento mascarado do titular

Example: ***456789-**

bankobjectoptional

Conta bancária associada à chave PIX no DICT

ispbstringoptional

ISPB da instituição

Example: 12345678

namestringoptional

Nome da instituição

Example: Banco Exemplo S.A.

bankNumberstringoptional

Código COMPE da instituição

Example: 237

branchNumberstringoptional

Agência

Example: 0001

accountNumberstringoptional

Número da conta

Example: 1234567

accountTypestringoptional

Tipo da conta informado pelo provedor

Example: CHECKING_ACCOUNT

descriptionstringoptional

createdAtstring · date-timerequired

requiresApprovalbooleanrequired

idempotencyKeystringoptional

paidAmountCentsinteger · int64optional

pendingAmountCentsinteger · int64optional

gowdEndToEndIdstringoptional

errorMessagestringoptional

batchTransactionsarrayrequired

sequenceinteger · int32optional

statusstringoptional

amountCentsinteger · int64optional

endToEndIdstringoptional

curl -X GET 'https://sandbox-api.rebornpay.io/v1/payouts/{pixTransactionId}' \  -H 'X-Api-Key: $API_KEY'

200Response example

{
  "pixTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "amount": 1,
  "currency": "string",
  "destinationKey": "string",
  "destinationKeyType": "string",
  "bankAccount": {
    "ispb": "string",
    "bankNumber": "string",
    "branchNumber": "string",
    "accountNumber": "string",
    "accountType": "string"
  },
  "recipient": {
    "name": "Joao da Silva",
    "documentType": "CPF",
    "documentNumber": "***456789-**",
    "bank": {
      "ispb": "12345678",
      "name": "Banco Exemplo S.A.",
      "bankNumber": "237",
      "branchNumber": "0001",
      "accountNumber": "1234567",
      "accountType": "CHECKING_ACCOUNT"
    }
  },
  "description": "string",
  "createdAt": "2025-01-15T10:30:00Z",
  "requiresApproval": false,
  "idempotencyKey": "string",
  "paidAmountCents": 1,
  "pendingAmountCents": 1,
  "gowdEndToEndId": "string",
  "errorMessage": "string",
  "batchTransactions": [
    {
      "sequence": 1,
      "status": "string",
      "amountCents": 1,
      "endToEndId": "string"
    }
  ]
}