Both Auth and AutoCapture API Endpoints are used to initiate a customer's application, authorize a PayBright transaction and Capture the transaction (AutoCapture only).

Response

Response for both Auth and AutoCapture APIs is sent to the x_url_complete and x_url_callback passed in the API requests by Merchant.

📘

Only difference between Response of Auth and AutoCapture APIs is the presence of x_transaction_type field in the response to Auth API. All other response fields are identical

Key

Type

Required

Example

Note

x_account_id

unicode string

Yes

Z9s7Yt0Txsqbbx

Echo request’s x_account_id

x_reference

ascii string

Yes

197831

Echo request’s x_reference

x_currency

iso-4217

Yes

CAD

Echo request’s x_currency

x_test

true/false

Yes

true

Echo request’s x_test

x_amount

decimal

Yes

89.99

Echo request’s x_amount

x_gateway_reference

unicode string

Yes

123

Unique reference for the authorization issued by the payment processor.

x_timestamp

iso-8601 in UTC

Yes

2014-03-24T12:15:41Z

Time of transaction completion. UTC Time: YYYY-MM-DDTHH:MM:SSZ

x_transaction_type

string

Yes for Auth and No for AutoCapture

authorization

Authorization only for Auth API. Field is not returned for AutoCapture API

x_result

fixed choice

Yes

completed

Valid values are completed, pending or failed

x_signatue

hex string, case-insensitive

Yes

49d3166063b4d881b50af0b4648c1244bfa9890a53ed6bce6d2386404b610777

See Signing Mechanism

x_message

ascii string

No

Billing address could not be verified.

A custom error message displayed to the customer.

Callbacks
Language
URL
Click Try It! to start a request and see the response here!