Acknowledge a Pix key claim
curl --request POST \
--url https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge \
--header 'Authorization: Bearer <token>' \
--header 'X-Idempotency: <x-idempotency>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Idempotency", "<x-idempotency>")
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: 'POST',
headers: {'X-Idempotency': '<x-idempotency>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge"
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, headers=headers)
print(response.text){
"claimId": "019606c3-5d6e-7f80-1b23-456789012cde",
"status": "WAITING_RESOLUTION"
}{
"code": "PIX-0030",
"title": "Idempotency Key Required",
"message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}{
"type": "https://errors.lerian.studio/v1/PIX-0145",
"title": "Not Found",
"status": 404,
"detail": "No claim was found for the given identifier and account.",
"code": "PIX-0145"
}{
"type": "https://errors.lerian.studio/v1/PIX-0144",
"title": "Conflict",
"status": 409,
"detail": "The X-Request-Id was already seen with a different request body.",
"code": "PIX-0144"
}{
"code": "PIX-0031",
"title": "Idempotency Key Conflict",
"message": "The Idempotency-Key was already used with a different request."
}{
"type": "https://errors.lerian.studio/v1/PIX-0146",
"title": "Unprocessable Entity",
"status": 422,
"detail": "The requested claim type and key type combination is not supported.",
"code": "PIX-0146"
}{
"type": "https://errors.lerian.studio/v1/PIX-0148",
"title": "Too Many Requests",
"status": 429,
"detail": "The rate limit for this claim operation has been exceeded.",
"code": "PIX-0148"
}{
"type": "https://errors.lerian.studio/v1/PIX-0000",
"title": "Internal Server Error",
"status": 500,
"detail": "internal error",
"code": "PIX-0000"
}{
"type": "https://errors.lerian.studio/v1/PIX-0140",
"title": "Bad Gateway",
"status": 502,
"detail": "internal error",
"code": "PIX-0140"
}{
"type": "https://errors.lerian.studio/v1/PIX-0164",
"title": "Service Unavailable",
"status": 503,
"detail": "internal error",
"code": "PIX-0164"
}{
"code": "ERR-0001",
"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"
}
}Acknowledge a Pix key claim
Acknowledges an OPEN donor-side Pix key claim when the automatic acknowledgement needs to be retried. The caller must be the donor participant. The operation has no request body.
POST
/
claims
/
{claim_id}
/
acknowledge
Acknowledge a Pix key claim
curl --request POST \
--url https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge \
--header 'Authorization: Bearer <token>' \
--header 'X-Idempotency: <x-idempotency>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Idempotency", "<x-idempotency>")
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: 'POST',
headers: {'X-Idempotency': '<x-idempotency>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/dict-hub/v1/claims/{claim_id}/acknowledge"
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, headers=headers)
print(response.text){
"claimId": "019606c3-5d6e-7f80-1b23-456789012cde",
"status": "WAITING_RESOLUTION"
}{
"code": "PIX-0030",
"title": "Idempotency Key Required",
"message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}{
"type": "https://errors.lerian.studio/v1/PIX-0145",
"title": "Not Found",
"status": 404,
"detail": "No claim was found for the given identifier and account.",
"code": "PIX-0145"
}{
"type": "https://errors.lerian.studio/v1/PIX-0144",
"title": "Conflict",
"status": 409,
"detail": "The X-Request-Id was already seen with a different request body.",
"code": "PIX-0144"
}{
"code": "PIX-0031",
"title": "Idempotency Key Conflict",
"message": "The Idempotency-Key was already used with a different request."
}{
"type": "https://errors.lerian.studio/v1/PIX-0146",
"title": "Unprocessable Entity",
"status": 422,
"detail": "The requested claim type and key type combination is not supported.",
"code": "PIX-0146"
}{
"type": "https://errors.lerian.studio/v1/PIX-0148",
"title": "Too Many Requests",
"status": 429,
"detail": "The rate limit for this claim operation has been exceeded.",
"code": "PIX-0148"
}{
"type": "https://errors.lerian.studio/v1/PIX-0000",
"title": "Internal Server Error",
"status": 500,
"detail": "internal error",
"code": "PIX-0000"
}{
"type": "https://errors.lerian.studio/v1/PIX-0140",
"title": "Bad Gateway",
"status": 502,
"detail": "internal error",
"code": "PIX-0140"
}{
"type": "https://errors.lerian.studio/v1/PIX-0164",
"title": "Service Unavailable",
"status": 503,
"detail": "internal error",
"code": "PIX-0164"
}{
"code": "ERR-0001",
"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
JWT bearer token issued by the identity provider.
Encabezados
REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.
Required string length:
1 - 64Parámetros de ruta
Ejemplo:
"019606c3-5d6e-7f80-1b23-456789012cde"
¿Esta página le ayudó?