API Reference

Submit a business response

post
https://example.com/v1/transactions/response

Submit a business response to a previously received transaction.

Business response must reference the transaction you want to respond to.

Use /response endpoint to submit a business response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

ISO 3166-1 alpha-2 uppercase country code the transaction is taking place in.

Validations:

  • The /transactions/response endpoint is not supported for this country.
string

A text note attached to a transaction. Notes are HTML enabled and will be displayed on the visual document.

Validations:

  • Maximum length: 3000
string
required

The external transaction identifier of the original transaction the response is referencing. e.g., MY_ORIGINAL_IDENTIFIER_0001

Validations:

  • Maximum length: 150
  • Required property
tax_reason
object
required

A value describing the business response type for the transaction.

Validations:

  • Required property
string
required

RFC3339 datetime string representing the point in time when transaction is executed.

Validations:

  • Required property
  • Must be an RFC3339 format date
string
required

External transaction identifier provided by the customer. e.g., MY_RESPONSE_IDENTIFIER_0001

Validations:

  • Maximum length: 150
  • Required property
Responses

401

Authentication failed - missing or incorrect subscription key

429

Too many requests were sent for a short period of time. Try again a bit later.

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?