Encaisser vers 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

POST /partner_api/escrows/{id}/collect

Authentification

ApiKey``ApiKeyId

X-API-KEY

Emplacement : header

X-API-KEY-ID

Emplacement : header

Paramètres de chemin

id*string

Escrow identifier

Formatuuid

Corps de la requête

application/json

Définitions TypeScript

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

type*string

Collect kind. data must match it.

Value in

• "payment_request"
• "payment_link"

data*EscrowCollectPaymentRequestData|EscrowCollectPaymentLinkData

Réponses

200 application/json

400 application/json

401 application/json

403 application/json

404 application/json

409 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/497f6eca-6276-4993-bfeb-53cbbbba6f08/collect" \
  -H "X-API-KEY: " \
  -H "X-API-KEY-ID: " \
  -H "Content-Type: application/json" \
  -d '{
    "type": "payment_request",
    "data": {
      "amountCents": 100,
      "currency": "str",
      "reference": "string",
      "paymentDetails": {
        "type": "redirect",
        "data": {
          "paymentMethod": "orange",
          "successUrl": "http://example.com",
          "errorUrl": "http://example.com"
        }
      }
    }
  }'

200400401403404409422500

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

Get escrow by ID (Partner API)GET\ \ Returns one escrow by id, including hold lifecycle status.\ **Access:** platform key only. Other merchants receive 404. Refund escrow (Partner API)POST\ \ Refunds a held escrow to the original payer.\ \ Principal leaves the escrow wallet via the PSP change path.\ Partner GET /transactions stays empty for this job.\ **Access:** platform key only.

Demander à l'IA ⌘I