Potapay(English)
    • Interface description
    • appoint
    • Signature & Signature Algorithm
    • Test parameter
    • Error code
    • v1
      • Create invoice order
        POST
      • Create a payment order
        POST
      • Order inquiry
        POST
      • Account balance inquiry
        POST
      • Certificate query
        POST
    • v2
      • Mexico
        • List of Mexican banks
        • Test parameters
        • Query
          • Order Inquiry
          • Account Balance Inquiry
          • Voucher Inquiry
        • Create a invioce order
        • Create a payment order
      • Brazil
        • Create invioce order
        • Create payment order - no query restrictions
        • Create payment order
        • Order inquiry
        • Account balance inquiry
        • Certificate query
    • webhook Request
      POST
    • Schemas
      • payin parameters
      • payin parameters v2
      • payout parameters
      • order query
      • balance query
      • webhook
      • proof query
      • payout manual

      webhook Request

      POST
      merchant_notify_url
      This interface is provided by the merchant. When the reception is successful, please respond with the http status code 200. The platform will determine that the notification is successful.
      When the status code is not 200, the system will resend after a period of time.
      Verification
      1.
      First, make sure that the received header and body are exactly the same as those sent.
      2.
      Use the corresponding language for verification.
      3.
      The returned signature needs to be base64 decoded before using rsa. If the sample code is used for verification, you need to carefully check whether it contains base64 decoding.

      Request

      Header Params

      Body Params application/json

      Example
      {
          "orderNo": "IV20230730055845-00030",
          "mchOrderNo": "vvVTsMDjZOqlxuesFSLZ",
          "identifier": "E0825353920230519130302198798530",
          "orderAmount": 100000,
          "amount": 99000,
          "fee": 1000,
          "payments": [
              {
                  "orderNo": "PA20230730055900-00031",
                  "identifier": "E0825353920230519130302198798530",
                  "orderAmount": 100000,
                  "amount": 99000,
                  "fee": 1000,
                  "performedAt": 1690696740
              }
          ],
          "performedAt": 0,
          "status": 3,
          "transMsg": "error message"
      }

      Request Code Samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location 'merchant_notify_url' \
      --header 'X-Account: b5373276-3924-4fbb-8845-acd15e910543' \
      --header 'X-Signature;' \
      --header 'Content-Type: application/json' \
      --data '{
          "orderNo": "IV20230730055845-00030",
          "mchOrderNo": "vvVTsMDjZOqlxuesFSLZ",
          "identifier": "E0825353920230519130302198798530",
          "orderAmount": 100000,
          "amount": 99000,
          "fee": 1000,
          "payments": [
              {
                  "orderNo": "PA20230730055900-00031",
                  "identifier": "E0825353920230519130302198798530",
                  "orderAmount": 100000,
                  "amount": 99000,
                  "fee": 1000,
                  "performedAt": 1690696740
              }
          ],
          "performedAt": 0,
          "status": 3,
          "transMsg": "error message"
      }'

      Responses

      🟢200success
      application/json
      Bodyapplication/json

      Example
      {}
      Modified at 2026-03-06 02:49:37
      Previous
      Certificate query
      Next
      payin parameters
      Built with