Skip to main content
GET
Get the credit status of a MED refund order

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

endToEndIdDevolucao
string
required

EndToEndId of the refund (pacs.004) whose credit status is being consulted.

Example:

"D1234567820240101000000000000099"

Response

OK

codigoDevolucao
string
required
deprecated

Deprecated: read refundCode, which carries the same value. Refund code (BE08=MED iniciada pelo participante do recebedor, FR01=fundada suspeita de fraude, MD06=solicitada pelo usuario recebedor, SL02=erro/desacordo no Pix Saque ou Troco).

Example:

"BE08"

dtHrSituacao
string
required
deprecated

Deprecated: read statusAt, which carries the same value. When the refund order reached this situation in JDPI (raw JDPI instant).

Example:

"2020-01-24T10:30:00.000Z"

ehIntraPsp
boolean
required
deprecated

Deprecated: read isIntraPsp, which carries the same value. True when the transaction is internal to this direct PSP (both legs on the same participant).

Example:

false

endToEndIdDevolucao
string
required
deprecated

Deprecated: read refundEndToEndId, which carries the same value. EndToEndId of the refund (pacs.004) whose credit is being consulted.

Example:

"D1234567820240101000000000000099"

isIntraPsp
boolean
required

True when the transaction is internal to this direct PSP (both legs on the same participant).

Example:

false

refundCode
string
required

Refund code (BE08=MED iniciada pelo participante do recebedor, FR01=fundada suspeita de fraude, MD06=solicitada pelo usuario recebedor, SL02=erro/desacordo no Pix Saque ou Troco).

Example:

"BE08"

refundEndToEndId
string
required

EndToEndId of the refund (pacs.004) whose credit is being consulted.

Example:

"D1234567820240101000000000000099"

stJdPi
integer<int64>
required

Request situation: -1=erro no processamento, 0=requisicao recebida aguardando processamento, 9=credito efetivado com sucesso.

Example:

9

stJdPiProc
integer<int64>
required

CREDIT-side processing situation: 0=requisicao recebida aguardando processamento, 1=credito validado aguardando efetivacao pelo SGCT, 2=validacao de credito enviada ao SPI, 5=sem retorno terminativo do SPI, 7=devolucao recusada pelo SPI, 8=devolucao recusada pelo JDPI, 9=credito efetivado com sucesso. A DISTINCT domain from the debit poll's stJdPiProc despite the shared field name.

Example:

9

statusAt
string
required

When the refund order reached this situation in JDPI (raw JDPI instant).

Example:

"2020-01-24T10:30:00.000Z"

codigoErro
string

Error code, present when stJdPi is -1.

Example:

"AB03"

descCodigoErro
string

Error-code description, present when stJdPi is -1.

Example:

"Liquidacao interrompida"

refundAmount
integer<int64>

Refunded amount, in centavos; omitted when JDPI did not return it (Obrg=Nao).

Example:

5010

valorDevolucao
integer<int64>
deprecated

Deprecated: read refundAmount, which carries the same value. Refunded amount, in centavos; omitted when JDPI did not return it (Obrg=Nao).

Example:

5010