For the complete documentation index, see llms.txt. This page is also available as Markdown.

Iнітний (перший) платіж

POST {{url}}/ecom/jws/scheduled_payments/payments/initial_subscription_v1

Це перший платіж, який підтверджує підписку клієнта. Він обов'язково проходить 3DS-аутентифікацію (підтвердження від власника картки).

Підтримувані методи оплати:

  • 💳 CARD — за номером картки (автоматично створюється токен для наступних списань)

  • 🔑 TOKEN — за існуючим токеном

  • 🍏 APPLE_PAY (encrypted / decrypted)

  • 🤖 GOOGLE_PAY (encrypted / decrypted)

Що відбувається після успішного платежу:

  1. Зберігається токен картки клієнта для майбутніх автоматичних списань

  2. Автоматично генерується повний графік запланованих платежів

  3. Мерчант отримує callback з результатом

Вхідні параметри

Параметр

Опис

Формат даних

Обовʼязковість

Приклад

merchantRequestId

Id запиту мерчанта

uuid (36)

Так

137d9304-0368-11ed-b939-0242ac120002

merchantId

Id мерчанту згенерований в Єкомі

uuid(36)

Так

137d9304-0368-11ed-b939-0242ac120002

paymentMethodType

Ознака, що визначає тип платіжного методу, через який здійснюється Purchase.

enum

Так

  1. CARD - по номеру

  2. TOKEN - по токену згенерованному в нашій системі

  3. APPLE_PAY_ENCRYPTED

  4. APPLE_PAY_DECRYPTED

  5. GOOGLE_PAY_ENCRYPTED

  6. GOOGLE_PAY_DECRYPTED

encryptedCardNumber

Номер карти зашифрований в JWE за допомогою публічного платіжного ключа

string

Так, якщо paymentMethodType = CARD

encryptedCardData

термін дії карти та cvv2 зашифровані в JWE. Перші 4 символи ExpDate, слідуючи 3 символи cvv

string

Так, якщо paymentMethodType = CARD

2503111 (розшифрований вигляд)

token

токен картки

string

Так, якщо paymentMethodType = TOKEN

paymentToken

оплата по закриптованному токену aPay

object

Так, якщо paymentMethodType = APPLE_PAY_ENCRYPTED

paymentDataEncrypted

оплата по розкриптованному токену aPay

object

Так, якщо paymentMethodType = APPLE_PAY_DECRYPTED або GOOGLE_PAY_DECRYPTED

googlePayPaymentData

оплата по закриптованному токену gPay

object

Так, якщо paymentMethodType = GOOGLE_PAY_ENCRYPTED

environment

середовище. По замовчуванню production

string

Так, GOOGLE_PAY_ENCRYPTED

TEST/PRODUCTION

orderId

id ордеру підписки

string

Так

browserInfo

об’єкт за даними браузера

object

Так

browserAcceptHeader

Http заголовок запиту

string

Так

text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9

browserUserAgent

програмний елемент браузера, що позначає систему, що користується нею

string

Так

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like,Gecko)Chrome/87.0.4280.66 Safari/537.36

browserLanguage

мова браузера

string

Так

en-US,en

browserColorDepth

значення глибини кольору екрана у браузері

string

Так

24

browserScreenHeight

висота області перегляду вікна браузера

string

Так

800

browserScreenWidth

широта області перегляду вікна браузера

string

Так

1280

browserTZ

Timezone браузера

string

Так

-180

merchantComment

додатковий коментар мерчанта

string

Ні

null

desiredThreeDSMode

Ознака яка вказує, чи бажає мерчант використати 3DS в покупці чи ні.

string

Так

За замовчуванням SHOULD

Можливі значення:

  • MUST - мерчант вимагає проведення платежу з 3DS

  • MUST_NOT - примусова операція без 3DS

  • SHOULD - якщо картка підтримує 3DS, то робимо перевірку

date

дата та час платежу

string

Так

{{currentdateT}}.00+00:00

comment

додаткова опис операції яку заповнює клієнт мерчанта

string

Ні

///5555.25412

purpose

призначення платежу яке заповнює мерчант

string

Ні

За товар

resultRedirectUrl

Url для редиректа клієнта після проходження 3DS аутентифікації

string

Ні

Вихідні параметри:

Параметр

Опис

Формат даних

Приклад

operationId

Id операціі

string

1712844596346b9F-WwrWZpq

ecomOperationId

Id операціі в системі Ecom

string

8c3303e9-7396-43b8-af4e-31d9facdde9b

status

статус операціі

string

SUСCESS FAIL PENDING REQUIRED_3DS

redirect3dsUrl

url для редиректа клієнта на сторінку емітента для проходження 3DS

string

Приклад запиту paymentMethodType CARD

Приклад запиту paymentMethodType TOKEN

Приклад запиту paymentMethodType APPLE_PAY_ENCRYPTED

Приклад запиту paymentMethodType APPLE_PAY_DECRYPTED

Приклад запиту paymentMethodType GOOGLE_PAY_DECRYPTED

Приклад запиту paymentMethodType GOOGLE_PAY_ENCRYPTED

Приклад відповіді

Останнє оновлення