Créer une réserve opérationnelle

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

POST /partner_api/escrows

Authentification

ApiKey``ApiKeyId

X-API-KEY

Emplacement : header

X-API-KEY-ID

Emplacement : header

Corps de la requête

application/json

Définitions TypeScript

Utilisez le type du corps de requête dans TypeScript.

storeId*string

Store that will receive the hold. Must belong to the authenticated merchant.

Formatuuid

holdUntil?string

When the hold expires and auto-releases to the merchant operating wallet. Defaults to 7 days from creation. Must be in the future and at most 30 days from now.

Formatdate-time

Réponses

200 application/json

400 application/json

401 application/json

403 application/json

404 application/json

422 application/json

500 application/json

cURL

JavaScript

Go

Python

Java

C#

Rust

curl -X POST "https://api.kelyko.invalid/partner_api/escrows" \
  -H "X-API-KEY: " \
  -H "X-API-KEY-ID: " \
  -H "Content-Type: application/json" \
  -d '{
    "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
  }'

200400401403404422500

{
  "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"
  }
}

List escrows (Partner API)GET\ \ Lists escrows for the authenticated merchant.\ \ Store-scoped platform keys only see their store. Lifecycle lives here —\ Partner `GET /transactions` stays operating-wallet only.\ **Access:** platform key only. Get escrow by ID (Partner API)GET\ \ Returns one escrow by id, including hold lifecycle status.\ **Access:** platform key only. Other merchants receive 404.

Demander à l'IA ⌘I