Перейти до змісту

Виплати з використанням токена (лише для сервісів категорії "Payment card")

Виплати по внутрішньому токену

Послідовність взаємодії:

  1. Здійснення щонайменше одного успішного платежа с функцією "токенізації" для отримання токена карти.
  2. Ініціювання виплати за токеном.

Токен використовується як альтернатива номеру платіжної карти.

Info

При обробці вашого запиту - пріоритет мають сервісні атрибути fields.У випадку наявності в запиті і токена і номера карти — останній буде мати більш високий пріоритет.

API: PRIVATE

Авторизація: BasicAuth

Endpoint: /payout-invoices

Method: POST

Приклад запиту (JSON)

    {
      "data":{
          "type":"payout-invoice",
          "attributes":{
            "test_mode": true,
            "reference_id": "my_order_id123",
            "description": "Payout Invoice Example",
            "currency": "USD",
            "amount": 100.78,
            "service": "payment_card_uah",
            "service_amount": 100.78,
            "token": "1Wrmk47zNKIGbo57znUzGy5ircN1FhPd",
            "callback_url": "https://example.com/payouts/callback",
            "options":{
                "auto_process":true
            },
            "customer":{
                "reference_id":"1203515",
                "email":"somename@domain.com",
                "name":"John Wick",
                "metadata":{
                  "key1":"value1",
                  "key2":"value2"
                }
            },
            "metadata":{
                "key":"value"
          }
        }
      }
    }

Приклад відповіді (JSON)

{
  "data": {
    "type": "payout-invoices",
    "id": "cpoi_CLFDSXqStt3ki8pe",
    "attributes": {
      "status": "created",
      "resolution": "ok",
      "amount": 100.78,
      "payout_amount": 100.78,
      "currency": "USD",
      "service_currency": "USD",
      "service_amount": 100.78,
      "service_payout_amount": 100.78,
      "reference_id": "my_order_id123",
      "test_mode": false,
      "description": "some description",
      "fee": 0,
      "writeoff": 100.78,
      "exchange_rate": 1,
      "failed": null,
      "processed": null,
      "processed_amount": null,
      "processed_fee": null,
      "processed_writeoff": null,
      "metadata": {
        "key": "value"
      },
      "created": 1756454183,
      "updated": 1756454183,
      "fields": {
        "card_number": "551928******0000"
      },
      "callback_url": "https://example.com/payouts/callback",
      "source": "merchant_api",
      "context": {
        "card": {
          "exp_year": "2027",
          "exp_month": "12",
          "card_holder": "John Wick",
          "reference_id": "ceeac179349e247ac69d0bbaf86ff7311793dbd06a160f242a3313d8c019b5e4"
        }
      },
      "callback_logs": [],
      "moderation_required": false,
      "payload": {
        "payment_card": {
          "network": "mastercard",
          "issuer_name": "U.S. BANK, N.A.",
          "issuer_country": "US"
        }
      },
      "payouts": []
    },
    "relationships": {
      "payout-service": {
        "data": {
          "type": "payout-services",
          "id": "payment_card_usd"
        }
      },
      "payout-method": {
        "data": {
          "type": "payout-methods",
          "id": "payment_card"
        }
      },
      "customer": {
        "data": {
          "type": "customers",
          "id": "cus_vcDlKkkCpyhb8jwg"
        }
      }
    },
    "links": {
      "self": "/api/payout-invoices/cpoi_CLFDSXqStt3ki8pe"
    }
  }
}

Виплати з використанням токена (лише для сервісу "Card token")

Послідовність взаємодії:

  1. Здійснення щонайменше одного успішного платежа с функцією "токенізації" для отримання токена карти.
  2. Ініціювання виплати за токеном.

Токен використовується як альтернатива номеру платіжної карти.

API: PRIVATE

Авторизація: BasicAuth

Endpoint: /payout-invoices

Method: POST

Приклад запиту (JSON)

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "test_mode": true,
      "reference_id": "",
      "description": "some description",
      "currency": "USD",
      "amount": 100.78,
      "service": "card_token",
      "service_amount": 100.78,
      "fields": {"token": "8PPO9ZJdv_3ZmDVqRuVYLSTnZMXXUetU"},
      "callback_url": "https://example.com/payouts/callback",
      "options": {
        "auto_process": true
      },
      "customer": {
        "reference_id": "1203515",
        "email": "somename@domain.com",
        "name": "John Wick",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        }
      },
      "metadata": {
        "key": "value"
      }
    }
  }
}