1. Home
  2. Docs
  3. PayBright API Reference v1.0
  4. VOID

REFUND

  • API endpoint:

    Sandbox URL for HTTP POST request:

    https://sandbox.paybright.com/checkout/api2.aspx

  • Sample Body for HTTP POST request:

    {“x_account_id”:”NjOcXFC8cvTPtAwv3TCGFvSamx74HPvTgm1s46CcGENMmbWF Ua”,”x_amount”:”1085.89″,”x_reference”:6441407187,”x_currency”:”CAD”, “x_gateway_reference”:”12343″,”x_test”:true,”x_url_callback”:”https:\/\/checkout.shopify.com\/services\/ping\/notify_integration\/paybright\/19629019″,”x_transaction_type”:”void”, “x_signature”:”33300c7f9017677a18487bccd4b652a22a6a647e8149f294302ce090deab07b2″}

  • API details:

    Please email us at contactus@paybright.com for the Sandbox ApiKey & Sandbox ApiToken.

    Sandbox ApiKey : NjOcXFC8cvTPtAwv3TCGFvSamx74HPvTgm1s46CcGENMmbWFUa

    Sandbox ApiToken : 9O49jqV5mW5wWvctuk3mjs9WW5A4VgW5wrtRSvaYSHfahaYOBX

  • POST Parameters:

    Key Type Example
    x_account_id(ApiKey)
    Required.
    Note:
    This is an account identifier assigned to the merchant by the payment processor.
    unicode string Z9s7Yt0Txsqbbx
    x_amount
    Required.
    decimal 89.99
    x_currency
    Required.
    iso-4217 CAD
    x_reference
    Required.
    Note:Unique reference of an order assigned by the merchant.
    unicode string 19783
    x_gateway_reference
    Required.
    unicode string Unique reference for the authorization issued by the payment processor.
    x_transaction_type
    Required.
    fixed choice void
    x_signature
    Required.
    Note:See signing mechanism part.
    hex string, case-insensitive 3a59e201a9b8692702b8c41dcba476d4a46e5f5c
    x_test
    Required.
    Note:Indicates whether or not this request should be processed in test mode (if supported).
    true/false true
    x_url_callback
    Required.
    Note:URL to which a callback notification should be sent asynchronously.
    url https://mystore.io/ping/1
  • PayBright will send response values to x_url_callback and to the initial request.

  • Response values for x_url_callback (POST):

    Key Type Example Note
    x_account_id(ApiKey)
    Required.
    unicode string Z9s7Yt0Txsqbbx Echo request’s x_account_id
    x_reference
    Required.
    ascii string 19783 Echo request’s x_reference
    x_currency
    Required.
    iso-4217 CAD Echo request’s x_currency
    x_test
    Required.
    true/false true Echo request’s x_test
    x_amount
    Required.
    decimal 89.99 Echo request’s x_amount
    x_gateway_reference
    Required.
    unicode string 123 Unique reference for the authorization issued by the payment processor.
    x_timestamp
    Required.
    iso-8601 in UTC 2014-03-24T12:15:41Z Time of transaction completion. UTC Time: YYYY-MM-DDTHH:MM:SSZ
    x_transaction_type
    Required.
    fixed choice void void
    x_result
    Required.
    fixed choice completed Valid values are completed, failed, or pending.
    x_signature
    Required.
    hex string, case-insensitive 49d3166063b4d881b50af0b4648c1244bfa9890a53ed6bce6d2386404b610777 See Signing Mechanism.
    x_message ascii string Billing address could not be verified. A custom error message displayed to the customer.