A valid request URL is required to generate request examples{
"status": "<string>",
"payment_methods": [
{
"type": "ExternalBilling",
"id": "<string>",
"active": true,
"primary": true,
"external_billing": {
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"merchant_accepted_payment": {
"payment_type": "<string>",
"account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"status": "ACTIVE",
"metadata": {}
}
],
"id": "<string>",
"external_id": "<string>",
"partner_customer_id": "<string>",
"type": "<string>",
"email": "<string>",
"language": "<string>",
"name": "<string>",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123
},
"metadata": {}
}{
"code": "invalid-request",
"message": "Invalid request."
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "account-not-found",
"message": "account not found"
}{
"code": "server-error",
"message": "<string>"
}Validate account
MarketONE invokes this endpoint to trigger validation of the customer’s account.
A valid request URL is required to generate request examples{
"status": "<string>",
"payment_methods": [
{
"type": "ExternalBilling",
"id": "<string>",
"active": true,
"primary": true,
"external_billing": {
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"merchant_accepted_payment": {
"payment_type": "<string>",
"account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"status": "ACTIVE",
"metadata": {}
}
],
"id": "<string>",
"external_id": "<string>",
"partner_customer_id": "<string>",
"type": "<string>",
"email": "<string>",
"language": "<string>",
"name": "<string>",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123
},
"metadata": {}
}{
"code": "invalid-request",
"message": "Invalid request."
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "account-not-found",
"message": "account not found"
}{
"code": "server-error",
"message": "<string>"
}Authorizations
The authorization key obtained from the CSP organization.
Headers
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.
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.
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
An account is the end customer account which is referenced in the billing system. The Account holds the terms of a relationship for the partner services that has been entitled to a Customer.
The type of a customer account identifier.
ban, msisdn, email, stbtoken, esn 20An identifier that can be used to locate an aggregator customer account.
256^[0-9]{10}$Identifies the OTT service requesting the account validation. If this parameter is missing, the request is being triggered by internal MarketONE processes.
16A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Response
An account object.
The Account represents a billing relationship with a customer. As such it can contain as much or as little information as you collect about customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in MarketONE for billing. An Account can have any number of children accounts and may have up to one parent account. An Account owns the “on file” payment methods to be used for billing. Payment Methods can be created at the same time as an Account being created or updated, but when updating an existing Payment Method the Payment Method Endpoint must be used.
Account status
The payment methods for this Account.
Show child attributes
Show child attributes
Primary account identifier. Either id or external_id is mandatory.
128An additional Aggregator-specified unique identifier for when you have two external (non-MarketONE) systems using two different identification schemes for the same customer. It can be used in place of vid or id. Mandatory in case id is not provided.
128Optional parameter used in case of migration of an existing customer and the same partner customer id need to be reused..
Account type
The email address associated with this Account.
The language (code) preferred for communications.
The name of the customer primarily associated with this Account.
The Address object represents a physical or mailing address.
Show child attributes
Show child attributes
A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Was this page helpful?