Skip to main content
POST
Create a new payment transaction

Authorizations

X-API-KEY
string
header
required

The authorization key obtained from MarketONE.

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

*/*

A new Transaction; required attributes are id, account vid, transaction items for amount and tax as appropriate, product code passed in as 'code' for transaction item, code value as 'TOTAL_TAX' for tax trasanction item.

The Transaction object provides a way to charge a customer.

id
string
required

A unique identifier.

Maximum string length: 128
amount
number
required

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

items
object[]
required

The array of Transaction Items belonging to this transaction. Items correspond to the charges.There will be 2 separate items - One for the actual amount and other for tax amount.

object
enum<string>

Value is “Transaction”

Available options:
Transaction
created
string<date-time>

The time this transaction was initiated.

currency
string

The ISO 4217 Currency Code of this transaction

partnersubscription
object

The Account represents an aggregator’s customer.

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.

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.

Response

Successfully created Transaction

The transaction response entity relates to the payment request that can be initiated either by the digital partner in the case of direct carrier billing (BILLING), or the backend billing system of the service provider at the end of every billing cycle.

id
string
required

A unique identifier.

Maximum string length: 128
status
string
required

Status of the transaction once processed (mandatory on the response)

extConfirmationId
string

Transaction identifier

Maximum string length: 36
metadata
object

A set of key/value pairs that you can attach to an object. Useful for storing additional information.