📘

"paymentMethodName": "SBP"

Payment Method Features

Possible Payment Scenarios:

Our API will provide you with all the necessary information to execute on of the following scenarios:

Workflow: Payment & Refund

Download in high resolution

Section “QR Generation”

[Step 1.3] You need to create a new intent

• Use the following API method to create an intent: *POST /processing/api/v1/intents*.
• When creating the intent, complete the Payment object.
• Most fields are common across all payment methods and are thoroughly described in the API Reference section.
• Method-specific parameters ( please make sure you provided them correctly):

  • "countryIsoCode": "RU" ← always “RU” for SBP payment method

  • "paymentMethodName": "SBP" ← always “SBP” for SBP payment method

  • "incomingDetails":

    JSON

    {
    	"successUrl": "Some Url",
    	"failUrl": "Some Url",
    	"returnUrl": "Some Url"
    }

• Ensure these all the required fields are completed accurately so that we can process your request correctly.

Request Example

{
  "clientReferenceId": "1234",
  "payments": [
    {
      "payer": {
        "countryIsoCode": "RU"
      },
      "paymentInstrument": {
        "paymentMethodName": "SBP",
        "incomingDetails": {
          "successUrl": "Some Url",
          "failUrl": "Some Url",
          "returnUrl": "Some Url"
        }
      },
      "description": "Purchase description",
      "webhookUrl": "webhookUrl",
      "submittedAmount": {
        "value": 100.05,
        "currency": "RUB"
      },
      "authCurrencyCode": "RUB"
    }
  ]
}

Fields description

[Step 1.7] Return the QR in response

• In the response, you will receive an additional object payments.additionalData. It contains the following fields**:**
  • QR_BASE64 – a QR code encoded in Base64
  • QR_LINK – a link that is converted into a QR code
  • REDIRECT_URL – a URL for redirection

Response Example

{
  "intentId": "232510340021612544",
  "payments": [
    {
      "id": "232510340646563840",
      "submittedAmount": {
        "value": 100.05,
        "currency": "RUB"
      },
      "authAmount": {
	      "value": 100.05,
        "currency": "RUB"
      },
      "payer": {
        "countryIsoCode": "RU"
      },
      "paymentInstrument": {
        "id": "PI204264628196626432",
        "paymentMethodId": "PM199507277233246209",
        "paymentMethodName": "SBP",
        "storedDetails": {
          "successUrl": "Some Url",
          "failUrl": "Some Url",
          "returnUrl": "Some Url"
        }
      },
      "status": "ACCEPTED",
      "additionalData": {
        "qrBase64": "qrBase64",
        "qrLink": "qrLink",
        "redirectUrl": "redirectUrl"
      }
    }
  ],
  "disbursements": [],
  "clientReferenceIntentId": "123456789",
  "paymentCreationErrors": [],
  "disbursementCreationErrors": [],
  "intentStatus": "CREATED"
}

Section “QR Payment”

[2.7] Receive the webhook with the transaction status

🔗

More about Payment Callbacks on the dedicated page

• After the transaction was processed and reached its final status (CAPTURED or DECLINED)
• The Platform will notify you about the latest status change via the callback

SIMPLE WEBHOOK WITH TRANSACTION STATUS

    {  
      "status": "AUTHORIZED",
      "errorCode": "CODE_PT0000",
      "errorMessage": "string"
    }

REFUNDS

📘

• They cannot exceed the total value of the original transaction
• Refund can be full or partial

[Step 5.1] Send a Refund Request

• To initiate the refund (full or partial) to the payer's original payment instrument, you must send a separate Refund request.
• If the payment involved FX and there two currencies involved, then you can use any these two currencies here.
• There is no difference between currencies, because we will use the historical rate that was used during the payment processing and the payer will receive the exact amount they spent.
• However you must fill in only one object paymentSubmittedAmount or paymentAuthAmount
  • paymentSubmittedAmount must be filled in the currency specified in field during the payment creation in submittedAmount.curency
  • paymentAuthAmount must be filled in the currency specified in field during the payment creation in authCurrencyCode
• Use the following endpoint: Create Refund inside existing Intent and specify the following parameters:

Example:

//For full refund
{
  "paymentId": 204264682781298700
  }
  
//For partial refund
{
  "paymentId": 204264682781298700,
  "partial": true,
  "paymentSubmittedAmount": {
    "value": 100.05,
    "currency": "RUB"
  },
  "webhookUrl": "webhookUrl"
}

• After the creation of the refund request you must wait for the callback, that will provide you with the latest transaction status

[5.5] Receive the webhook with the transaction status

🔗

More about Refund Callbacks on the dedicated page

• After the transaction was processed and reached its final status (REFUNDED or DECLINED)
• The Platform will notify you about the latest status change via the callback

SIMPLE WEBHOOK WITH TRANSACTION STATUS

    {  
      "status": "REFUNDED",
      "errorCode": "CODE_PT0000",
      "errorMessage": "string"
    }