Aurpay API
    • Aurpay Crypto Payment Integration
    • API-Key Authentication Method
      • Order
        • Get Payment URL
        • Get Payment Info
        • Get Orders
        • Get Orders Details
        • Get Orders Refund Info
        • Orders Refund
        • Get Transaction
        • Get Support Crypto Currency List
        • Get Support Real Currency List
      • Wallets
        • Get Wallets List
        • Withdraw Balance
        • Get Self Custody Wallets
      • Bitcoin Lightning Network
        • Get BLN Balance
        • Create BLN Order
        • Create BLN Withdraw
      • Get API-Key
        POST
    • Signature Authentication Method
      • Order
        • Get Payment URL
        • Get Payment Info
        • Get Support Real Currency List
        • Get Support Crypto Currency List
        • Get Orders
        • Get Orders Details
        • Get Transaction
        • Get Orders Refund Info
        • Orders Refund
      • Wallets
        • Get Wallets List
        • Withdraw Balance
        • Get Self Custody Wallets
      • Bitcoin Lightning Network
        • Get BLN Balance
        • Create BLN Order
        • Create BLN Withdraw
    • Callbakc Description
      • Callback Authentication Method

    Aurpay Crypto Payment Integration

    The API Documentation includes pre-configured automation scripts and can be directly imported for testing.

    Authentication#

    API Key Authentication#

    Use the API-Key endpoint to obtain API credentials.
    Recommended for testing environments only. Signature authentication is recommended for production use.

    Signature Authentication#

    Retrieve the required credentials from the API Management page.
    See: Signature Authentication Method

    Create Orders#

    Method 1#

    Generate an Aurpay hosted checkout URL. Users select the cryptocurrency on the checkout page before the order is created. Suitable for simple integrations.
    API Endpoint: POST - Get Payment URL
    Returns a hosted checkout URL where users can select the desired cryptocurrency and complete the payment.
    If only one cryptocurrency is enabled for the merchant account, the order will be created automatically.

    Method 2#

    Directly create a cryptocurrency payment order with complete order details. Suitable for custom or deeply integrated applications.
    API Endpoint: POST - Get Payment Info
    Returns complete order information, including the hosted checkout payment URL.
    Developers may use the returned crypto payment data for custom integrations or redirect users directly to the checkout page.

    Checkout Redirect#

    While the user is on the checkout page, Aurpay will redirect the user to the configured url when the order status changes for the first time. Final order states include succeed and timeout.
    succeed_url: Redirect URL triggered when the order status changes to succeed. No redirect will occur if left empty.
    timeout_url: Redirect URL triggered when the order status changes to timeout. No redirect will occur if left empty.
    Additional parameters may be appended to the redirect url during order creation to associate the payment with the original merchant order.
    Example: https://example.com/succeed/<id>?type=web
    Flexible custom configurations are also supported.

    Order Callback Integration#

    Aurpay sends callbacks to the configured URLs whenever the order status changes. Final order states include succeed and timeout.
    callback_url: Callback URL triggered after successful payment (GET)
    timeout_callback: Callback URL triggered after order timeout (GET)
    Callbacks are sent using the GET method without additional query parameters or request bodies. The expected response status code is 200.
    Similar to redirect URLs, callback URLs may also include custom parameters as needed.

    Callback Authentication#

    Used to verify that callback requests originate from Aurpay servers.
    Note: Once an order is created, callback configurations are stored only on Aurpay servers and cannot be retrieved externally.
    Simple Authentication
    Add authentication parameters directly to the callback URL.
    Example: https://example.com/callback/<id>?token=****
    Signature Authentication
    Retrieve the relevant configuration from the Callback Signature page.
    See: Callback Authentication Method for integration details.
    Next
    API-Key Authentication Method
    Built with