Get the credit status of a MED refund order

curl --request GET \
  --url https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "isIntraPsp": false,
  "refundCode": "BE08",
  "refundEndToEndId": "D1234567820240101000000000000099",
  "stJdPi": 9,
  "stJdPiProc": 9,
  "statusAt": "2020-01-24T10:30:00.000Z",
  "codigoErro": "AB03",
  "descCodigoErro": "Liquidacao interrompida",
  "refundAmount": 5010
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Get the credit status of a MED refund order

Returns the CREDIT-side situation of a refund order by its pacs.004 endToEndIdDevolucao, read live from JDPI (JDPI credito-devolucao/, §8.5.4). stJdPiProc here is the CREDIT domain, DISTINCT from the debit poll’s despite the shared field name (§4.5). Moves no money and persists nothing — the credit itself is settled by the inbound §9.3.3 webhook, never by this read. Optional ispb names the direct participant the request acts for: named, the record has to be one that participant is a party to, or the answer is 404 PIX-0147 before anything is read from JDPI or changed; an ISPB this deployment does not act as is 422 PIX-0128 before any record is read; a token confined to one participant has to name it. Optional indirectId names the registered indirect participant the request acts for: named, the refund credit has to be booked against a payment this deployment recorded for that indirect, or the answer is 404 PIX-0147 before anything is read from JDPI; a token confined to one indirect has to name it; a malformed indirectId is 400 PIX-0061.

GET

med

refunds

credits

{endToEndIdDevolucao}

Get the credit status of a MED refund order

curl --request GET \
  --url https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/refunds/credits/{endToEndIdDevolucao}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "isIntraPsp": false,
  "refundCode": "BE08",
  "refundEndToEndId": "D1234567820240101000000000000099",
  "stJdPi": 9,
  "stJdPiProc": 9,
  "statusAt": "2020-01-24T10:30:00.000Z",
  "codigoErro": "AB03",
  "descCodigoErro": "Liquidacao interrompida",
  "refundAmount": 5010
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

endToEndIdDevolucao

string

requerido

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

Ejemplo:

"D1234567820240101000000000000099"

Parámetros de consulta

ispb

string

The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the record has to be one that participant is a party to - either side of a dispute, the creator of a value recovery, the participant a refund credit was booked for - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed. A record this deployment does not hold is 404 PIX-0147 too when an ispb is named. An ISPB this deployment does not act as is 422 PIX-0128, before any record is read. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9A-Z]{8}$

Ejemplo:

"12345678"

indirectId

string<uuid>

The registered indirect participant (UUID) this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the refund credit has to be booked against a payment this deployment recorded for that indirect - the payment's own indirectId, as GET /v1/transactions?indirectId= reads it - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed; a record this deployment does not hold is 404 PIX-0147 too when an indirectId is named. It is ROUTING DATA you supply, never a credential, and a token confined to one indirect has to name it here. Not a valid UUID is 400 PIX-0061. Sending it empty (indirectId=) reads the same as omitting it.

Ejemplo:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

Respuesta

isIntraPsp

boolean

requerido

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

Ejemplo:

false

refundCode

string

requerido

Refund code (BE08=MED started by the recipient's PSP, FR01=well-founded suspicion of fraud, MD06=requested by the recipient, SL02=error or disagreement on a Pix Saque or Pix Troco).

Ejemplo:

"BE08"

refundEndToEndId

string

requerido

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

Ejemplo:

"D1234567820240101000000000000099"

stJdPi

integer<int64>

requerido

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

Ejemplo:

9

stJdPiProc

integer<int64>

requerido

CREDIT-side processing situation: 0=request received, awaiting processing, 1=credit validated, awaiting settlement by the SGCT, 2=credit validation sent to SPI, 5=no final answer from SPI, 7=refund refused by SPI, 8=refund refused by JDPI, 9=credit settled. A DISTINCT domain from the debit poll's stJdPiProc despite the shared field name.

Ejemplo:

9

statusAt

string

requerido

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

Ejemplo:

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

codigoErro

string

Error code, present when stJdPi is -1.

Ejemplo:

"AB03"

descCodigoErro

string

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

Ejemplo:

"Liquidacao interrompida"

refundAmount

integer<int64>

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

Ejemplo:

5010

APIs del participante directo

APIs de participantes indirectos

Get the credit status of a MED refund order

Autorizaciones

Parámetros de ruta

Parámetros de consulta

Respuesta