v1

latestOpenAPI 3.0.02026-07-2613985.6 KB

Payment requests

Create a payment request

Create a payment request for the client for a specified amount and a configurable expiration time.

post/requests

Headers

X-Processing-Signaturestring required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Request body

amountstring required

Payment request amount that you want to receive from the customer.

user_fee_percent0 | 100

Percentage of processing fees paid by the customer.

Currently, only two values are supported:

0 (the default) — the processing fee is paid by the merchant.
100 — the processing fee is paid by the customer.

life_time_durationinteger nullable required

Payment request lifetime (duration in seconds). Include either this parameter or life_time_datetime. At least one of these fields is required.

life_time_datetimeinteger nullable required

Payment request lifetime (exact expiry timestamp). Include either this parameter or life_time_duration. At least one of these fields is required.

end_user_emailstring

If the amount the customer pays does not match the amount that you set for the payment request, CryptoProcessing will send an email to this address instructing the customer on how they can receive a refund. If they paid less, they will receive a full refund. If they paid more, the customer will get instructions on how to be refunded the difference.

end_user_referencestring

The unique ID of the customer this payment request is for. You can use it to group payment requests by customer.

sender_type'natural' | 'legal'

Type of the merchant's customer who sends the funds.

Use natural if the sender is an individual person and legal if the sender is a legal entity. The selected type determines which fields must be included in sender_data.

descriptionstring

Payment request description that the customer will see.

foreign_idstring

Unique foreign ID in your system. Must not contain personal data, such as the user's name or email address.

url_storestring

URL of the store page. The customer can click a button on the payment form to return to this URL (for example, if they change their mind or want to pick a different payment method). We recommend setting this to the URL of the checkout page.

url_successstring

URL of the success page. The customer will be able to return to this address once the payment is completed.

url_failedstring

URL of the failed payment page. The customer will be able to return to this address if the payment fails.

Example request

{
  "amount": "100.50",
  "currency": {
    "iso": "EUR"
  },
  "life_time_duration": 3600,
  "life_time_datetime": 1773768946,
  "end_user_email": "customer@example.com",
  "description": "Order #123",
  "foreign_id": "order_123",
  "url_store": "https://example.com/store",
  "url_success": "https://example.com/success",
  "url_failed": "https://example.com/fail"
}

Response

Example response

{
  "data": {
    "id": "0196f6a1-cab2-76fb-84c7-7e9ee9ddf6b4",
    "amount": "100.50",
    "currency": {
      "iso": "EUR"
    },
    "status": "created",
    "end_user_email": "customer@example.com",
    "description": "Order #123 payment",
    "foreign_id": "uuid string"
  }
}