Consulter une réserve

Fonction avancée à cadrer

Les réserves opérationnelles de cette référence ne sont ni le cantonnement réglementaire ni un service de séquestre juridique garanti. Leur activation dépend du dispositif partenaire et du périmètre plateforme.

Opération

GET /partner_api/escrows/{id}

Authentification

ApiKey``ApiKeyId

X-API-KEY

Emplacement : header

X-API-KEY-ID

Emplacement : header

Paramètres de chemin

id*string

Escrow identifier

Formatuuid

Réponses

200 application/json

401 application/json

403 application/json

404 application/json

500 application/json

cURL

JavaScript

Go

Python

Java

C#

Rust

curl -X GET "https://api.kelyko.invalid/partner_api/escrows/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "X-API-KEY: " \
  -H "X-API-KEY-ID: "

200401403404500

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  "status": "pending",
  "holdUntil": "2019-08-24T14:15:22Z",
  "amount": {
    "amount": 0,
    "currency": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "collect": {
    "type": "payment_request",
    "status": "pending",
    "errorReason": "string",
    "reference": "string",
    "redirectUrl": "string",
    "link": "string",
    "amount": {
      "amount": 0,
      "currency": "string"
    },
    "fees": {
      "amount": 0,
      "currency": "string"
    },
    "paymentMethod": "string",
    "counterpartIdentifier": "string"
  },
  "release": {
    "amount": {
      "amount": 0,
      "currency": "string"
    },
    "fees": {
      "amount": 0,
      "currency": "string"
    },
    "autoRelease": true
  },
  "refund": {
    "status": "pending",
    "amount": {
      "amount": 0,
      "currency": "string"
    },
    "fees": {
      "amount": 0,
      "currency": "string"
    },
    "paymentMethod": "string",
    "counterpartIdentifier": "string"
  }
}

Create escrow (Partner API)POST\ \ Creates a pending escrow pot for one later collect.\ \ Start its collect with `POST /partner_api/escrows/{id}/collect`.\ This endpoint does not collect money.\ **Access:** merchant-scoped platform key (plateforme–issued) only.\ Owner / Dashboard keys and the plateforme business key receive 403. Collect escrow (Partner API)POST\ \ Starts the collect of a pending escrow, as a payment request or a payment link.\ `type` selects the collect and `data` carries its fields (the store comes from the escrow).\ Retry on a `failed` escrow once its previous payment request can no longer be paid; the new\ collect replaces the old one. Payment links never fail the escrow: the payer retries on the link.\ **Access:** platform key only.

Demander à l'IA ⌘I