1. Payment
Casharc
  • API
    • Merchant
      • Balance
        • Balance
      • Payment
        • README
        • Payment
          POST
        • Payment Detail
          GET
        • Payment Refund
          POST
        • Payment Cancel
          POST
      • Payout
        • Payout
        • Payout Detail
        • Payout Cancel
      • Appeal
        • Appeal
        • Appeal Detail
        • Appeal Cancel
  1. Payment

README

Required Request Headers
HeaderTypeRequiredDescription
X-Public-KeystringrequiredThe merchant's public API key. Must be included in every request and is used together with X-Secret-Key to authenticate the client.
X-Secret-KeystringrequiredThe merchant's secret API key. Must be included in every request to authenticate the client. Keep this key secure and never expose it in client-side applications.
Idempotency-KeystringrequiredA unique identifier for the request used to ensure idempotent operations. Repeating a request with the same idempotency key returns the original result instead of creating a duplicate operation. Each key should be unique for every create or cancel request.
Payment
FieldTypeRequiredDescription
amountstringrequiredPayment amount represented as a decimal string (e.g. 100.50). Must be greater than 0.
currencystringrequiredPayment currency in ISO 4217 format (e.g. UAH, EUR, USD).
amount_tolerance_upstringoptionalMaximum allowed overpayment amount. Payments exceeding amount + amount_tolerance_up will be rejected. If omitted, overpayments are not allowed.
expires_inintegeroptionalLifetime of the payment request in seconds. Once expired, the assigned payment requisites become invalid and can no longer be used.
requisiteobjectrequiredCriteria used to select the payment requisites that will be assigned to the customer.
customerobjectrequiredCustomer information used for fraud detection, risk assessment, and payment routing.
metadataobjectoptionalArbitrary key-value data associated with the payment. This information is stored and returned in API responses and webhooks but is not processed by the system.
Response Body
FieldTypeDescription
idstringUnique payment identifier in the system.
typestringOperation type. For this endpoint, usually payment, payout.
requestedobjectOriginal amount and currency requested by the merchant.
initializedobjectAmount and currency initialized by the system after applying routing, limits, or tolerance rules.
processedobjectAmount and currency actually processed after payment confirmation.
refundedobjectAmount and currency that has been refunded. If no refund was made, the amount is usually 0.
requisiteobjectPayment requisites assigned to the customer for completing the payment.
statusstringCurrent payment status, for example created, processing, partially_completed, completed, declined, expired, partially_refunded, refunded, or canceled.
expires_atstringDate and time when the payment expires. Usually returned in ISO 8601 format.
created_atstringDate and time when the payment was created. Usually returned in ISO 8601 format.
updated_atstringDate and time when the payment was last updated. Usually returned in ISO 8601 format.
metadataobjectCustom merchant data passed during payment creation. Returned without modification.
Previous
Balance
Next
Payment
Built with