CRM Open API DocumentationCRM Open API Documentation
REST API
Webhooks
PSP Open API
External Exchange Rates
REST API
Webhooks
PSP Open API
External Exchange Rates
  • PSP Open API Introduction
  • Signature Algorithm
  • API Specifications

    • 1. PSP Get Payment URL
    • 2. PSP Payment Callback
  • Errors

2. PSP Payment Callback

This asynchronous callback interface allows tenants (third-party systems) to notify the CRM about payment results. After receiving the payment result from the Payment Service Provider (PSP), the tenant can immediately invoke this interface to inform the CRM of the outcome.

POST {CRM_Callback_URL}/pay/callback

Headers

KetValue
crm-pay-tokenThe token CRM generates

Request Body

NameTypeRequiredDescription
merchant_idstringMandatoryMerchant ID generated by CRM after PSP Integration is created.
order_nostringMandatoryUnique Order ID generated by CRM for each payment.
transaction_idstringOptionalTransaction ID generated by the third party.
amountnumberMandatoryPayment amount.
currencystringMandatoryCurrency code (e.g., USD, EUR).
timenumberMandatoryPayment completion time (Unix timestamp in milliseconds).
statusnumberMandatoryPayment status (0: Fail, 1: Success, 2: Processing).
user_idstringOptionalCRM customer ID.
signstringMandatoryData signature (refer to Signature Algorithm

Sample Request

{
  "merchant_id": "f23eb3a856284d0a87913e33ed581852",
  "order_no": "td0bhyp3lqm1",
  "transaction_id": "98765434567876",
  "amount": 432.98,
  "currency": "USD",
  "time": 1631696419516,
  "user_id": "ewem9cab",
  "status": 1,
  "sign": ""
}

Expected HTTP status code

  • 204
Last Updated:: 10/16/24, 7:13 AM
Prev
1. PSP Get Payment URL