Revoke a receipt link

DELETE/payments/{id}/receipt-links/{link_id}Probar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Parámetros de rutaidstringobligatoriolink_idstringobligatorio

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

DELETE

/payments/{id}/receipt-links/{link_id}

const url = 'http://localhost:3000/v1/payments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/receipt-links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url http://localhost:3000/v1/payments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/receipt-links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'x-api-key: <x-api-key>'

Scope payments:write. The link stops working immediately. Revoking it again is harmless. A link of another payout or another account returns 404 receipt_not_found.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

string format: uuid

link_id

required

string format: uuid

Responses

204

Revoked

404

Error con código estable

application/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error upstream_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}