We have added the following new Response Codes.

• 2102 Unknown due to PSP read timeout
• 4802 Invalid key identifier: Account is already in use.

We have added the following new Response Codes.

• 1004 Success
• 4293 Customer Name Verification Failed
• 4294 Transaction Rejected By Customer
• 4295 Transaction Rejected By Issuer
• 4296 Transaction Has Violations
• 4297 Payment Attempt Blocked
• 4407 Refund Error: Transaction has already been refunded (fully or partially) and a full refund can no longer be performed
• 4408 Refund Error: Partial refund cannot be performed for this transaction
• 4409 Refund Error: Refund cannot be performed for this transaction
• 4410 Refund Error: Refund cannot be performed for this transaction as it has been voided
• 4501 Card not found at network
• 4502 Ineligible
• 4617 Payout has been declined
• 4618 Payout has failed
• 4624 Payout limit exceeded
• 4625 Payout payee account not found
• 4626 Payout held by merchant decision engine
• 4627 Switching key required
• 4628 Invalid switching key
• 4800 Transaction Error: Token payments or payouts not yet supported for the specified payment service provider
• 4801 Transaction Error: Token is not valid for the specified payment service provider
• 4700 Tokenization Error: Network token unsupported
• 5012 Server Error: Scheme reference data not present while trying to perform Merchant Initiated Transaction
• 5013 Server Error: Integration with payment service provider is temporarily unavailable
• 5306 Network Unavailable

We have added the following new Response Codes.

• 4041 Entity not found on Merchant system
• 4298 Invalid Currency
• 4299 Invalid Country Code

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.

We have added a new paymentRails field to PaymentResponseand PaymentStatusResponse

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

• Create a Payment

We have added a new Response Code.

• 4292 Unable to route transaction

Fixed a number of regex in OpenAPI schema, so that they comply with OpenAPI standard.

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

• Custom Metadata validation errors

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 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.

We have added new 'Merchant' risk instrument