Skip to main content
POST
Error

Authorizations

X-API-KEY
string
header
required

The authorization key obtained from the CSP organization.

Headers

X-B3-TraceId
string

The TraceId indicates the overall ID of the trace. Every span in a trace shares this ID. The X-B3-TraceId header is encoded as 32 or 16 lower-hex characters. For example, a 128-bit TraceId header might look like 463ac35c9f6413ad48485a3953bb6124.

X-B3-SpanId
string

The SpanId is 64-bit in length and indicates the position of the current operation in the trace tree. The value should not be interpreted; it may or may not be derived from the value of the TraceId. The X-B3-SpanId header is encoded as 16 lower-hex characters. For example, a SpanId header might look like a2fb4a1d1a96d312. Unless propagating only the Sampling State, the X-B3-SpanId header is required.

X-B3-ParentSpanId
string

The ParentSpanId is 64-bit in length and indicates the position of the parent operation in the trace tree. When the span is the root of the trace tree, there is no ParentSpanId. The X-B3-ParentSpanId header may be present on a child span and must be absent on the root span. It is encoded as 16 lower-hex characters. For example, a ParentSpanId header might look like 0020000000000001.

Body

application/json

The Transaction object provides a way to charge a customer.

id
string
required

A unique identifier.

Maximum string length: 128
created
string<date-time>
required

The time this transaction was initiated.

amount
number
required

The net amount of the charge presented by this transaction, as a decimal. Must be positive (zero allowed).

currency
string
required

The ISO 4217 Currency Code of this transaction

account
object
required

The Account represents an Aggregator’s customer.

payment_method
object
required
items
object[]
required

The array of Transaction Items belonging to this transaction. Items correspond to the charges.

partnerCode
string

A unique code representing the OTT submitting the transaction.partner code is mandatory for OTT Managed transactions but not mandatory for M1 managed transactions

billing_descriptor
string

Optional “soft descriptor” to send to the Aggregator for this transaction.

original_billing_date
string<date-time>

The original scheduled billing date associated with the billing for which this transaction collects funds. For an initial attempt, this is the same as the transaction date; for a retry transaction this is the original attempt date.

metadata
object

A set of key/value pairs that you can attach to an object. Useful for storing additional information. For transactions resulting from a subscription, the metadata is also inherited from the subscription.

Response

A Validate Transaction Response object.

status
enum<string>
required

Indicates if the request was processed succesfully or not.

Available options:
success,
failure
Maximum string length: 32
confirmationId
string
required

An aggregator generated identifier to keep track of the confirmation received.

Maximum string length: 256