API docs by Redocly

Batch Docs (1.0)

Download OpenAPI specification:Download

Build Information

Branch: BCS-136

SHA: 2bfac056

Batch

Get batch collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

seller_name
string [ 1 .. 1024 ] characters
Examples: seller_name=Apruve seller_name=BestBuy seller_name=Lenovo

The name of the seller.

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

xml_data
string non-empty

The XML data for the batch.

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

status
string
Enum: "Unprocessed" "Processed" "Error"

Batch status

batch_detail_count
number >= 0

The number of batch details associated with this batch.

batch_detail_unprocessed_count
number >= 0

The number of batch details with a status of Unprocessed or Retry associated with this batch.

batch_detail_error_count
number >= 0

The number of batch details with a status of Error associated with this batch.

batch_detail_draft_count
number >= 0

The number of batch details that has draft data.

batch_detail_cancelled_count
number >= 0

The number of batch details with a status of Cancelled associated with this batch.

processed_at
string <date-time>

Date/time the resource was processed.

error_log
string non-empty

The error log is populated when the resource has a processing status of 'Error'. The log may hint at the cause of failure.

error_at
string <date-time>

Date/time the resource failed processing.

user_updated_at
string <date-time>
Examples: user_updated_at=2019-01-01 user_updated_at=2019-01-01T23:59:59Z user_updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated through public API. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

user_updated_by
string
Examples: user_updated_by=Lauren Brandon user_updated_by=ReadOnlyAPIKey

The user name or API key the resource was last updated through public API.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get batch

path Parameters
batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

Batch Detail

Get batch detail collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

customer_name
string [ 1 .. 1024 ] characters

Optional name for the customer

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

charge_id
string <uuid>
Example: charge_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge ID

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

order_number
string [ 1 .. 824 ] characters

The seller's order number in the seller's format

transaction_type
string
Enum: "Charge" "Refund"

The type of transaction

xml_data
string non-empty

The XML data for the batch detail.

request_data
string non-empty

The 3Rivers Charge or Refund API request.

draft_request_data
string non-empty

The draft 3Rivers Charge or Refund API request.

response_data
string non-empty

3Rivers response data.

amount
integer

The batch detail currency amount.

currency
string non-empty

The batch detail currency.

vehicle_odometer
string non-empty

The vehicle odometer reading.

vehicle_identification_number
string non-empty

The vehicle identification number.

vehicle_unit_number
string non-empty

The vehicle unit number.

status
string
Enum: "Unprocessed" "Retry" "Processed" "Error" "Cancelled"

Batch detail status

processed_at
string <date-time>

Date/time the resource was processed.

error_code
string non-empty

3Rivers API or BCS internal error code.

error_description
string non-empty

3Rivers API or BCS internal error message.

error_at
string <date-time>

Date/time the resource failed processing.

retry_count
integer >= 0

The number of times processing of the resource has failed.

user_updated_at
string <date-time>
Examples: user_updated_at=2019-01-01 user_updated_at=2019-01-01T23:59:59Z user_updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated through public API. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

user_updated_by
string
Examples: user_updated_by=Lauren Brandon user_updated_by=ReadOnlyAPIKey

The user name or API key the resource was last updated through public API.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get batch detail

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "customer_name": "string",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_number": "string",
  • "order_number": "string",
  • "transaction_type": "Charge",
  • "xml_data": "string",
  • "request_data": "string",
  • "draft_request_data": "string",
  • "response_data": "string",
  • "amount": 0,
  • "currency": "string",
  • "vehicle_odometer": "string",
  • "vehicle_identification_number": "string",
  • "vehicle_unit_number": "string",
  • "retry_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_code": "string",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Batch Detail History

Get batch detail history collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail history resource ID

batch_detail_id
string <uuid>
Example: batch_detail_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

charge_id
string <uuid>
Example: charge_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge ID

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

order_number
string [ 1 .. 824 ] characters

The seller's order number in the seller's format

transaction_type
string
Enum: "Charge" "Refund"

The type of transaction

xml_data
string non-empty

The XML data for the batch detail.

request_data
string non-empty

The 3Rivers Charge or Refund API request.

draft_request_data
string non-empty

The draft 3Rivers Charge or Refund API request.

response_data
string non-empty

3Rivers response data.

amount
integer

The batch detail currency amount.

currency
string non-empty

The batch detail currency.

vehicle_odometer
string non-empty

The vehicle odometer reading.

vehicle_identification_number
string non-empty

The vehicle identification number.

vehicle_unit_number
string non-empty

The vehicle unit number.

status
string
Enum: "Unprocessed" "Retry" "Processed" "Error" "Cancelled"

Batch detail status

processed_at
string <date-time>

Date/time the resource was processed.

error_code
string non-empty

3Rivers API or BCS internal error code.

error_log
string non-empty

The error log is populated when the resource has a processing status of 'Error'. The log may hint at the cause of failure.

error_at
string <date-time>

Date/time the resource failed processing.

retry_count
integer >= 0

The number of times processing of the resource has failed.

user_updated_at
string <date-time>
Examples: user_updated_at=2019-01-01 user_updated_at=2019-01-01T23:59:59Z user_updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated through public API. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

user_updated_by
string
Examples: user_updated_by=Lauren Brandon user_updated_by=ReadOnlyAPIKey

The user name or API key the resource was last updated through public API.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get batch detail history

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_detail_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_number": "string",
  • "order_number": "string",
  • "transaction_type": "Charge",
  • "xml_data": "string",
  • "request_data": "string",
  • "draft_request_data": "string",
  • "response_data": "string",
  • "amount": 0,
  • "currency": "string",
  • "vehicle_odometer": "string",
  • "vehicle_identification_number": "string",
  • "vehicle_unit_number": "string",
  • "retry_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_code": "string",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Batch Detail Log

Get batch detail log collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail log resource ID

batch_detail_log_id
string <uuid>
Example: batch_detail_log_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail log resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

charge_id
string <uuid>
Example: charge_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge ID

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_detail_id
string <uuid>
Example: batch_detail_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

request_data
string non-empty

3Rivers request data.

response_data
string non-empty

3Rivers response data.

response_status
number [ 100 .. 599 ]

3Rivers HTTP response status code.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get batch detail log

path Parameters
batch_detail_log_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail log resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_detail_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "request_data": "string",
  • "response_data": "string",
  • "response_status": 100,
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Processing Report

Get processing report

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page. This is only supported for JSON-formatted processing reports.

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned. This is only supported for JSON-formatted processing reports.

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

batch_detail_id
string <uuid>
Example: batch_detail_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

seller_name
string [ 1 .. 1024 ] characters
Examples: seller_name=Apruve seller_name=BestBuy seller_name=Lenovo

The name of the seller.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

customer_name
string [ 1 .. 1024 ] characters

Optional name for the customer

buyer_id
string <uuid>
Example: buyer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers buyer ID

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge or refund ID

type
string
Enum: "Charge" "Refund"

The type of transaction

amount
string <int> [ 1 .. 900000000000000 ]

The total amount of the charge or refund. It includes the sum of all details subtotal + shipping amount + shipping tax amount - shipping discount amount + foreign exchange fee.

status
string
Enum: "Created" "Pending" "Rejected" "Error"

Resolved processing report 3Rivers status.

transaction_time
string <date-time>

Date/time the charge or refund was successfully processed through the 3Rivers Charge or Refund API.

order_number
string [ 1 .. 824 ] characters

The seller's order number in the seller's format

po_number
string [ 1 .. 200 ] characters

This may be required by some buyers/sellers based on their configuration.

currency
string^[A-Z]{3}$
Examples: currency=AUD currency=USD currency=NZD currency=EUR currency=GBP

Unique ISO 4217 currency code

vehicle_odometer
string non-empty

The vehicle odometer reading.

vehicle_identification_number
string non-empty

The vehicle identification number.

vehicle_unit_number
string non-empty

The vehicle unit number.

error_code
string non-empty

3Rivers API or BCS internal error code.

error_description
string non-empty

3Rivers API or BCS internal error message.

columns
string non-empty
Examples: columns=transaction_time,customer_id,customer_name,id,total,order_number,po_number,seller_id,seller_name,type,currency,status columns=batch_number,seller_id,seller_name,customer_id,customer_name,buyer_id,id,type,total,status,transaction_time,order_number,po_number,currency,error_code,error_description columns=buyer_id columns=customer_id,customer_name

Comma-separated column names to be displayed in the CSV-formatted processing report. Used only for CSV-formatted processing reports.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Datetime of when BCS initially received the settlement file, but before the charge was created in 3Rivers. The :gte and :lte operators must be used to specify the date range for PDF-formatted processing reports

header Parameters
Accept
string (Processing Report Accept Request Header)
Enum: "application/json" "application/pdf" "text/csv"

This can be used to control the response format. The default response format is JSON.

Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Program Customers

Get program customer collection

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

name
string [ 1 .. 1024 ] characters

Optional name for the customer

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client program customer

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
string [ 1 .. 1024 ] characters

Optional name for the customer

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "string",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z"
}

Delete client program customer

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client program customer

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "string",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z"
}

Create client program customer with ID

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
string [ 1 .. 1024 ] characters

Optional name for the customer

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "string",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z"
}

Update client program customer

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
string [ 1 .. 1024 ] characters

Optional name for the customer

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "string",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z"
}

Client Program Seller Contacts

Get client program seller contact collection

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique batch service seller contact resource ID.

seller_contact_id
string <uuid>
Example: seller_contact_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique batch service seller contact resource ID.

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the seller contact.

email
string
Examples: email=systems-bestbuy@multiservice.com

Seller physical contact address email address.

country
string
Examples: country=US

Seller physical contact address country.

state
string
Examples: state=TX

Seller physical contact address state.

city
string
Examples: city=Farmers Branch

Seller physical contact address city.

street
string
Examples: street=4255 Lyndon B Johnson Fwy

Seller physical contact address street.

post_code
string
Examples: post_code=90210

Seller physical contact address postal code.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client program seller contact

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

seller_contact_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique batch service seller contact resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "email": "systems-bestbuy@multiservice.com",
  • "country": "US",
  • "state": "TX",
  • "city": "Farmers Branch",
  • "street": "4255 Lyndon B Johnson Fwy",
  • "post_code": "90210",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Client Program Sellers

Get client program seller collection

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

alternate_seller_id
string [ 1 .. 50 ] characters
Example: alternate_seller_id=3c87bd2b

An alternate version of the seller ID. Can be used by systems that support different seller ID formats other than a uuid

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the seller.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client program seller

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
alternate_seller_id
string [ 1 .. 50 ] characters

An alternate version of the seller ID. Can be used by systems that support different seller ID formats other than a uuid

name
required
string [ 1 .. 1024 ] characters

The name of the seller.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve",
  • "status": "Created",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Get client program seller

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve",
  • "status": "Created",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Create client program seller with ID

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
alternate_seller_id
string [ 1 .. 50 ] characters

An alternate version of the seller ID. Can be used by systems that support different seller ID formats other than a uuid

name
required
string [ 1 .. 1024 ] characters

The name of the seller.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve",
  • "status": "Created",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update client program seller

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
alternate_seller_id
string [ 1 .. 50 ] characters

An alternate version of the seller ID. Can be used by systems that support different seller ID formats other than a uuid

name
required
string [ 1 .. 1024 ] characters

The name of the seller.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve",
  • "status": "Created",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Client Programs

Get client program collection

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the program.

status
any
Enum: "Created" "Active" "Inactive" "Terminated" "Archived"
reply_to_email
string <= 200 characters
support_email
string <= 200 characters
sender_email
string <= 200 characters
processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client program

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string [ 1 .. 1024 ] characters

The name of the program.

status
required
any
Enum: "Created" "Active" "Inactive" "Terminated" "Archived"
reply_to_email
required
string <idn-email> <= 200 characters
support_email
required
string <idn-email> <= 200 characters
sender_email
required
string <idn-email> <= 200 characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Delete client program

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client program

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Create client program with ID

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string [ 1 .. 1024 ] characters

The name of the program.

status
required
any
Enum: "Created" "Active" "Inactive" "Terminated" "Archived"
reply_to_email
required
string <idn-email> <= 200 characters
support_email
required
string <idn-email> <= 200 characters
sender_email
required
string <idn-email> <= 200 characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update client program

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string [ 1 .. 1024 ] characters

The name of the program.

status
required
any
Enum: "Created" "Active" "Inactive" "Terminated" "Archived"
reply_to_email
required
string <idn-email> <= 200 characters
support_email
required
string <idn-email> <= 200 characters
sender_email
required
string <idn-email> <= 200 characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Delete client program seller

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Report Schedule

Get client program report schedule collections

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client program report schedule

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
report_id
required
string <uuid>

Unique report resource ID.

schedule_tz
required
string

The timezone the report schedule should use when determining when the report should be scheduled and the data that is included in the report.

schedule_frequency
required
any
Enum: "Daily" "Weekly" "Monthly"

The frequency the report is able to be run. A report cannot be scheduled for a frequency the report does not support.

schedule_week_day
any
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"

When the schedule frequency is weekly, this defines the day of the week the report will be scheduled.

recipient_emails
required
Array of strings <idn-email> non-empty [ items <idn-email > ]

The email addresses the resulting report should be emailed to.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Delete client program report

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client program report schedule

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update client program report

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
report_id
required
string <uuid>

Unique report resource ID.

schedule_tz
required
string

The timezone the report schedule should use when determining when the report should be scheduled and the data that is included in the report.

schedule_frequency
required
any
Enum: "Daily" "Weekly" "Monthly"

The frequency the report is able to be run. A report cannot be scheduled for a frequency the report does not support.

schedule_week_day
any
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"

When the schedule frequency is weekly, this defines the day of the week the report will be scheduled.

recipient_emails
required
Array of strings <idn-email> non-empty [ items <idn-email > ]

The email addresses the resulting report should be emailed to.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Clients

Get client collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the client.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string [ 1 .. 1024 ] characters

The name of the client.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Delete client

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Create client with ID

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string [ 1 .. 1024 ] characters

The name of the client.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update client

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string [ 1 .. 1024 ] characters

The name of the client.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Seller Report Schedule

Get client program seller report schedule collections

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create client program seller report schedule

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
report_id
required
string <uuid>

Unique report resource ID.

schedule_tz
required
string

The timezone the report schedule should use when determining when the report should be scheduled and the data that is included in the report.

schedule_frequency
required
any
Enum: "Daily" "Weekly" "Monthly"

The frequency the report is able to be run. A report cannot be scheduled for a frequency the report does not support.

schedule_week_day
any
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"

When the schedule frequency is weekly, this defines the day of the week the report will be scheduled.

recipient_emails
required
Array of strings <idn-email> non-empty [ items <idn-email > ]

The email addresses the resulting report should be emailed to.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Delete client program seller report

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client program seller report schedule

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update client program seller report

path Parameters
client_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
report_id
required
string <uuid>

Unique report resource ID.

schedule_tz
required
string

The timezone the report schedule should use when determining when the report should be scheduled and the data that is included in the report.

schedule_frequency
required
any
Enum: "Daily" "Weekly" "Monthly"

The frequency the report is able to be run. A report cannot be scheduled for a frequency the report does not support.

schedule_week_day
any
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"

When the schedule frequency is weekly, this defines the day of the week the report will be scheduled.

recipient_emails
required
Array of strings <idn-email> non-empty [ items <idn-email > ]

The email addresses the resulting report should be emailed to.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Sellers

Get seller collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

alternate_seller_id
string [ 1 .. 50 ] characters
Example: alternate_seller_id=3c87bd2b

An alternate version of the seller ID. Can be used by systems that support different seller ID formats other than a uuid

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the seller.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get seller

path Parameters
seller_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "alternate_seller_id": "3c87bd2b",
  • "name": "Apruve",
  • "status": "Created",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Customers

Get customer collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

name
string [ 1 .. 1024 ] characters

Optional name for the customer

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get customer

path Parameters
customer_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "string",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z"
}

File

Get file collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

name
string non-empty

Unique name of the file

status
string
Enum: "Stored" "Processing" "Processed" "Error"

The status of the file.

processed_at
string <date-time>

Date/time the resource was processed.

error_log
string non-empty

The error log is populated when the resource has a processing status of 'Error'. The log may hint at the cause of failure.

error_at
string <date-time>

Date/time the resource failed processing.

retry_count
integer >= 0

The number of times processing of the resource has failed.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create file

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string non-empty

Unique name of the file

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "name": "string",
  • "status": "Stored",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "retry_count": 0,
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Get file

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "name": "string",
  • "status": "Stored",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "retry_count": 0,
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update file

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
name
required
string non-empty

Unique name of the file

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "name": "string",
  • "status": "Stored",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "retry_count": 0,
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

File Batch

Get file batch collection

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

seller_name
string [ 1 .. 1024 ] characters
Examples: seller_name=Apruve seller_name=BestBuy seller_name=Lenovo

The name of the seller.

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

xml_data
string non-empty

The XML data for the batch.

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

status
string
Enum: "Unprocessed" "Processed" "Error"

Batch status

batch_detail_count
number >= 0

The number of batch details associated with this batch.

batch_detail_unprocessed_count
number >= 0

The number of batch details with a status of Unprocessed or Retry associated with this batch.

batch_detail_error_count
number >= 0

The number of batch details with a status of Error associated with this batch.

batch_detail_draft_count
number >= 0

The number of batch details that has draft data.

batch_detail_cancelled_count
number >= 0

The number of batch details with a status of Cancelled associated with this batch.

processed_at
string <date-time>

Date/time the resource was processed.

error_log
string non-empty

The error log is populated when the resource has a processing status of 'Error'. The log may hint at the cause of failure.

error_at
string <date-time>

Date/time the resource failed processing.

user_updated_at
string <date-time>
Examples: user_updated_at=2019-01-01 user_updated_at=2019-01-01T23:59:59Z user_updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated through public API. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

user_updated_by
string
Examples: user_updated_by=Lauren Brandon user_updated_by=ReadOnlyAPIKey

The user name or API key the resource was last updated through public API.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get file batch

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

Update file batch

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Request Body schema: application/json
status
required
string
Value: "Unprocessed"

Batch status

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "status": "Unprocessed"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

Cancel Batch

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
batch_detail_ids
Array of strings <uuid> >= 0 items [ items <uuid > ]

List of batch detail ids that needs to be processed

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "batch_detail_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

Cancel Batch Drafts

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
batch_detail_ids
Array of strings <uuid> >= 0 items [ items <uuid > ]

List of batch detail ids that needs to be processed

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "batch_detail_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

Confirm Batch Drafts

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
batch_detail_ids
Array of strings <uuid> >= 0 items [ items <uuid > ]

List of batch detail ids that needs to be processed

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "batch_detail_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

Download file batch with errors CSV

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update file batch with errors CSV

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retry Batch

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
batch_detail_ids
Array of strings <uuid> >= 0 items [ items <uuid > ]

List of batch detail ids that needs to be processed

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "batch_detail_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_name": "Apruve",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "xml_data": "string",
  • "batch_number": "string",
  • "batch_detail_count": 0,
  • "batch_detail_unprocessed_count": 0,
  • "batch_detail_error_count": 0,
  • "batch_detail_draft_count": 0,
  • "batch_detail_cancelled_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon"
}

File Batch Detail

Get file batch detail collection

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

customer_name
string [ 1 .. 1024 ] characters

Optional name for the customer

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

charge_id
string <uuid>
Example: charge_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge ID

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

order_number
string [ 1 .. 824 ] characters

The seller's order number in the seller's format

transaction_type
string
Enum: "Charge" "Refund"

The type of transaction

xml_data
string non-empty

The XML data for the batch detail.

request_data
string non-empty

The 3Rivers Charge or Refund API request.

draft_request_data
string non-empty

The draft 3Rivers Charge or Refund API request.

response_data
string non-empty

3Rivers response data.

amount
integer

The batch detail currency amount.

currency
string non-empty

The batch detail currency.

vehicle_odometer
string non-empty

The vehicle odometer reading.

vehicle_identification_number
string non-empty

The vehicle identification number.

vehicle_unit_number
string non-empty

The vehicle unit number.

status
string
Enum: "Unprocessed" "Retry" "Processed" "Error" "Cancelled"

Batch detail status

processed_at
string <date-time>

Date/time the resource was processed.

error_code
string non-empty

3Rivers API or BCS internal error code.

error_description
string non-empty

3Rivers API or BCS internal error message.

error_at
string <date-time>

Date/time the resource failed processing.

retry_count
integer >= 0

The number of times processing of the resource has failed.

user_updated_at
string <date-time>
Examples: user_updated_at=2019-01-01 user_updated_at=2019-01-01T23:59:59Z user_updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated through public API. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

user_updated_by
string
Examples: user_updated_by=Lauren Brandon user_updated_by=ReadOnlyAPIKey

The user name or API key the resource was last updated through public API.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get file batch detail

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "customer_name": "string",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_number": "string",
  • "order_number": "string",
  • "transaction_type": "Charge",
  • "xml_data": "string",
  • "request_data": "string",
  • "draft_request_data": "string",
  • "response_data": "string",
  • "amount": 0,
  • "currency": "string",
  • "vehicle_odometer": "string",
  • "vehicle_identification_number": "string",
  • "vehicle_unit_number": "string",
  • "retry_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_code": "string",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Update file batch detail

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))
Request Body schema: application/json
status
required
string
Value: "Unprocessed"

Batch detail status

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "status": "Unprocessed"
}

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "customer_name": "string",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_number": "string",
  • "order_number": "string",
  • "transaction_type": "Charge",
  • "xml_data": "string",
  • "request_data": "string",
  • "draft_request_data": "string",
  • "response_data": "string",
  • "amount": 0,
  • "currency": "string",
  • "vehicle_odometer": "string",
  • "vehicle_identification_number": "string",
  • "vehicle_unit_number": "string",
  • "retry_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_code": "string",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

File Batch Detail History

Get file batch detail history collection

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_detail_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail history resource ID

batch_detail_id
string <uuid>
Example: batch_detail_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

charge_id
string <uuid>
Example: charge_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge ID

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_number
string [ 1 .. 20 ] characters

The seller's batch number in the seller's format

order_number
string [ 1 .. 824 ] characters

The seller's order number in the seller's format

transaction_type
string
Enum: "Charge" "Refund"

The type of transaction

xml_data
string non-empty

The XML data for the batch detail.

request_data
string non-empty

The 3Rivers Charge or Refund API request.

draft_request_data
string non-empty

The draft 3Rivers Charge or Refund API request.

response_data
string non-empty

3Rivers response data.

amount
integer

The batch detail currency amount.

currency
string non-empty

The batch detail currency.

vehicle_odometer
string non-empty

The vehicle odometer reading.

vehicle_identification_number
string non-empty

The vehicle identification number.

vehicle_unit_number
string non-empty

The vehicle unit number.

status
string
Enum: "Unprocessed" "Retry" "Processed" "Error" "Cancelled"

Batch detail status

processed_at
string <date-time>

Date/time the resource was processed.

error_code
string non-empty

3Rivers API or BCS internal error code.

error_log
string non-empty

The error log is populated when the resource has a processing status of 'Error'. The log may hint at the cause of failure.

error_at
string <date-time>

Date/time the resource failed processing.

retry_count
integer >= 0

The number of times processing of the resource has failed.

user_updated_at
string <date-time>
Examples: user_updated_at=2019-01-01 user_updated_at=2019-01-01T23:59:59Z user_updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated through public API. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

user_updated_by
string
Examples: user_updated_by=Lauren Brandon user_updated_by=ReadOnlyAPIKey

The user name or API key the resource was last updated through public API.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get file batch detail history

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_detail_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_detail_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_number": "string",
  • "order_number": "string",
  • "transaction_type": "Charge",
  • "xml_data": "string",
  • "request_data": "string",
  • "draft_request_data": "string",
  • "response_data": "string",
  • "amount": 0,
  • "currency": "string",
  • "vehicle_odometer": "string",
  • "vehicle_identification_number": "string",
  • "vehicle_unit_number": "string",
  • "retry_count": 0,
  • "status": "Unprocessed",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "error_code": "string",
  • "error_log": "string",
  • "error_at": "2019-08-24T14:15:22Z",
  • "user_updated_at": "2019-01-01",
  • "user_updated_by": "Lauren Brandon",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

File Batch Detail Log

Get file batch detail log collection

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_detail_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail log resource ID

batch_detail_log_id
string <uuid>
Example: batch_detail_log_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail log resource ID

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

customer_id
string <uuid>
Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925

Unique customer resource ID

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

charge_id
string <uuid>
Example: charge_id=d1363171-4587-4f8d-b276-977691e4a925

Unique 3Rivers charge ID

file_id
string <uuid>
Example: file_id=d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
string <uuid>
Example: batch_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_detail_id
string <uuid>
Example: batch_detail_id=d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

request_data
string non-empty

3Rivers request data.

response_data
string non-empty

3Rivers response data.

response_status
number [ 100 .. 599 ]

3Rivers HTTP response status code.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get file batch detail log

path Parameters
file_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique file resource ID

batch_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch resource ID

batch_detail_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail resource ID

batch_detail_log_id
required
string <uuid>
Example: d1363171-4587-4f8d-b276-977691e4a925

Unique batch detail log resource ID

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "charge_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "file_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "batch_detail_id": "d1363171-4587-4f8d-b276-977691e4a925",
  • "request_data": "string",
  • "response_data": "string",
  • "response_status": 100,
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Programs

Get program collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the program.

status
any
Enum: "Created" "Active" "Inactive" "Terminated" "Archived"
reply_to_email
string <= 200 characters
support_email
string <= 200 characters
sender_email
string <= 200 characters
processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get program

path Parameters
program_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "status": "Created",
  • "reply_to_email": "пошта@укр.нет",
  • "support_email": "пошта@укр.нет",
  • "sender_email": "пошта@укр.нет",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Report

Get report collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report resource ID.

report_id
string <uuid>
Example: report_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report resource ID.

name
string [ 1 .. 1024 ] characters
Examples: name=Transaction Processing Report name=Transaction Rejection Report

The name of the report.

supported_schedule_frequencies
Array of any non-empty
Items Enum: "Daily" "Weekly" "Monthly"

The set of schedule frequencies the report supports.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get report

path Parameters
report_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Transaction Processing Report",
  • "supported_schedule_frequencies": [
    ],
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Report Schedule

Get report schedule collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

report_schedule_id
string <uuid>
Example: report_schedule_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

report_id
string <uuid>
Example: report_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report resource ID.

report_scope
any
Enum: "Client" "Seller"

The scope the report schedule has been created under. The report schedule scope determines visibility of the report schedule.

schedule_tz
string
Example: schedule_tz=GMT+10

The timezone the report schedule should use when determining when the report should be scheduled and the data that is included in the report.

schedule_frequency
any
Enum: "Daily" "Weekly" "Monthly"

The frequency the report is able to be run. A report cannot be scheduled for a frequency the report does not support.

schedule_week_day
any
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
Example: schedule_week_day=Monday

When the schedule frequency is weekly, this defines the day of the week the report will be scheduled.

recipient_emails
Array of strings <idn-email> non-empty [ items <idn-email > ]

The email addresses the resulting report should be emailed to.

last_scheduled_at
string <date-time>

The UTC timestamp of the most recently scheduled report for this schedule.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get report schedule

path Parameters
report_schedule_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique report schedule resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "report_scope": "Client",
  • "schedule_tz": "GMT+10",
  • "schedule_frequency": "Daily",
  • "schedule_week_day": "Monday",
  • "recipient_emails": [
    ],
  • "last_scheduled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Seller Contacts

Get seller contact collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

client_id
string <uuid>
Example: client_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique client resource ID.

program_id
string <uuid>
Example: program_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique program resource ID.

seller_id
string <uuid>
Example: seller_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique seller resource ID.

id
string <uuid>
Example: id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique batch service seller contact resource ID.

seller_contact_id
string <uuid>
Example: seller_contact_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique batch service seller contact resource ID.

name
string [ 1 .. 1024 ] characters
Examples: name=Apruve name=BestBuy name=Lenovo

The name of the seller contact.

email
string
Examples: email=systems-bestbuy@multiservice.com

Seller physical contact address email address.

country
string
Examples: country=US

Seller physical contact address country.

state
string
Examples: state=TX

Seller physical contact address state.

city
string
Examples: city=Farmers Branch

Seller physical contact address city.

street
string
Examples: street=4255 Lyndon B Johnson Fwy

Seller physical contact address street.

post_code
string
Examples: post_code=90210

Seller physical contact address postal code.

processed_message_ts
string <date-time>
Examples: processed_message_ts=2019-01-01T23:59:59.999Z

The timestamp of the message that created or updated this resource. This is used to ignore duplicate messages, and ensure that messages are not processed out-of-order

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get seller contact

path Parameters
seller_contact_id
required
string <uuid>
Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique batch service seller contact resource ID.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "seller_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "name": "Apruve",
  • "email": "systems-bestbuy@multiservice.com",
  • "country": "US",
  • "state": "TX",
  • "city": "Farmers Branch",
  • "street": "4255 Lyndon B Johnson Fwy",
  • "post_code": "90210",
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}

Settlement

Upload a settlement file

Settlement file uploads currently support Servicegate XML V2
https://gitlab.com/msts-enterprise/ox/batch/-/wikis/Engineering/BatchFileSpecification

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

SQS Message

Get SQS Message collection

query Parameters
sort_column[]
Array of strings non-empty [ items non-empty ]
Examples: sort_column[]=created_at sort_column[]=-updated_at

Specify the resource property name to sort the API response in ascending order. To sort in descending order, prefix the resource property name with a -.

page_size
integer [ 1 .. 250 ]
Default: 10
Example: page_size=20

Number of records per page

page_number
integer >= 1
Default: 1
Example: page_number=2

If the requested page does not exist, an empty collection is returned.

id
string <uuid>
Example: id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The unique id assigned by SQS to a message.

correlation_id
string [ 1 .. 1024 ] characters
Example: correlation_id=e86f4f0d-329d-42a7-be3e-f13ef305d111

The correlation ID of the API request that generated this resource.

queue_url
string <= 2000 characters ^https://

The url of the SQS queue from which this message was received.

group_id
string

Messages that belong to the same message group are always processed one by one, in a strict order relative to the message group. However, messages that belong to different message groups might be processed out of order. This property matches the MessageGroupId in the original SQS message, if present. If not, it is extracted from the message body by this service.

subject
string [ 1 .. 1024 ] characters

The subject that was published to the SNS topic.

body
string non-empty

The message body of the SQS message.

attributes
string non-empty

Metadata about the message in a JSON document published to the SNS topic.

status
any
Enum: "Unprocessed" "Processed" "Failed"

The status of the message. It is inserted as 'unprocessed', which is eligible for processing by an application consumer.

error_log
string non-empty

The error log is populated when the SQS message has a status of 'Failed'. The log may hint at the cause of failure.

failure_count
integer >= 0

The number of times processing the SQS message record has failed.

failed_at
string <date-time>

Date/time the SQS message processing last failed.

processed_at
string <date-time>

Date/time the SQS message was processed.

created_at
string <date-time>
Examples: created_at=2019-01-01 created_at=2019-01-01T23:59:59Z created_at=2019-01-01T23:59:59.999Z

Date/time the resource was created. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

updated_at
string <date-time>
Examples: updated_at=2019-01-01 updated_at=2019-01-01T23:59:59Z updated_at=2019-01-01T23:59:59.999Z

Date/time the resource was last updated. When used as a query parameter, only the formats in the examples are supported. If only a date is specified, the date timezone is assumed to be UTC.

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get SQS Message

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

required
object (X-Authenticated-Request header payload (v1.0.0))
required
object (X-Authenticated-Request-Permissions header payload (v1.0.0))

Responses

Response samples

Content type
application/json
{
  • "id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "queue_url": "string",
  • "group_id": "string",
  • "subject": "string",
  • "body": "string",
  • "attributes": "string",
  • "status": "Unprocessed",
  • "error_log": "string",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-01-01",
  • "updated_at": "2019-01-01"
}