Changelog

Additional fields in payment and payout notifications

We have added customerOrderCode and merchantTransactionId to payment notifications.
We have added reference and merchantTransactionId to payout notifications.

CustomerOrderCode is your own code provided to reference a transaction on BR-DGE portal.
MerchantTransactionId is a unique identifier provided by you upon initial transaction.

Additional Information

  • For more detailed information and examples, please refer to the complete API documentation.
  • If you have any further questions, please contact customer support.

Added paymentRails field

We have added a new paymentRails field to PaymentResponseand PaymentStatusResponse

See the following endpoints for more information on the PaymentResponse object.

Added custom metadata fields for payments and payouts

We have added new custom metadata fields for Payments and Payouts

Custom metadata allows you to include additional information with each transaction, giving you more flexibility and
control over your payment processing. You will soon be able to define your own routing rules based on this metadata, optimizing payment
processing and improving customer satisfaction.

To add custom metadata, use the Create a Payment
or Create a Payout endpoints.

Send the metadata as name-value pairs, where the name is the field name and the value is the data you want to associate
with that field.

Example

{
    "customMetadata": {
        "customer_type": "VIP",
        "order_id": "1234567890"
    }
}

Limitations

  • You can send a maximum of 25 name-value pairs per transaction.
  • Each key or value can be up to 200 characters long.
  • Keys can only contain alphanumeric characters, hyphens, underscores, commas, and spaces.
  • Leading and trailing spaces are not allowed in keys.

Validation Errors

The following new errors are associated with custom metadata validation failures

Important Notes

  • Security: Custom metadata is not encrypted.
  • Availability: This functionality is available to all merchants.
  • Scope: Custom metadata is only considered for the initial payment request in 3DS transactions and is ignored in any
    subsequent 3DS requests.
  • Refunds, voids, and captures do not support custom metadata
  • Retrieval: You can retrieve the custom metadata associated with a transaction using
    the Get Payment Status
    or Get Payout Status endpoints.
  • Custom metadata is currently not supported for Hosted Payments Page

Additional Information

  • For more detailed information and examples, please refer to the complete API documentation.
  • If you have any further questions, please contact customer support.

Added Paypal Orders

Added Create PayPal Order endpoint

We have added a new POST endpoint to our API: [POST /v1/paypal/orders], that will create an order with PayPal and return the order ID.