Dispute Docs (1.0)

Download OpenAPI specification:

Build Information

Branch: main

SHA: 9f596cc9

Attachment Groups

Get attachment group 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 attachment group resource ID.
dispute_id	string <uuid> Example: dispute_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer 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.
title	string <= 50 characters The title of the attachment group.
description	string The description of the attachment group.
uploader_name	string <= 200 characters The name of the entity that uploaded the attachment group. This is the name of the 3Rivers user.
uploader_email	string <email> <= 200 characters The email of the entity that uploaded the attachment group. This could be the email of either a 3Rivers user or a Service Cloud user.
uploader_source	string Enum: "Application User" "Support User" "Application Integration" "Internal Integration" "Processing" The source of the entity that uploaded the attachment group.
uploader_source_id	string The ID of the source that uploaded the attachment group. This could be a 3Rivers user id, a Service Cloud user id, a Processing user id or an API Key id.
uploader_user_type	string Enum: "Support" "Client" "Customer" "Seller" The type of user that uploaded the attachment group.
status	string Enum: "Active" "Deleted" Example: status=Active The status of the attachment group
deleted_at	string <date-time> Examples: deleted_at=2019-01-01T23:59:59.999Z The timestamp indicating when the attachment group was deleted.
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

Error Code	Description
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
internal_error	An internal error has occurred.

Response samples

200
400
401
403
500

Content type

application/json

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"title": "string",
"description": "string",
"uploader_name": "string",
"uploader_email": "user@example.com",
"uploader_source": "Application User",
"uploader_source_id": "string",
"uploader_user_type": "Support",
"status": "Active",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Get attachment group

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

Error Code	Description
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
resource_not_found	Resource not found.

Error Code	Description
internal_error	An internal error has occurred.

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"title": "string",
"description": "string",
"uploader_name": "string",
"uploader_email": "user@example.com",
"uploader_source": "Application User",
"uploader_source_id": "string",
"uploader_user_type": "Support",
"status": "Active",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Charge Disputes

Create charge dispute

path Parameters

charge_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique charge 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

reason required	string Enum: "Buyer Does Not Recognize Charge" "Buyer Tax Exempt or Incorrect Tax" "Defective or Damaged Merchandise" "Duplicate PO or Transaction" "Incorrect or Missing Information" "Incorrect Invoice Date" "Incorrect Item" "Incorrect Price or Discount" "Services Not Rendered or Delivery Not Taken" "Transaction Billed To Wrong Buyer" "Manufacturers Warranty" "Misdirected Payment to 3rd Party" "Fraud/Unauthorized Purchase" "Transaction Paid To Client Direct" "Incorrect Seller Paid" "Other" The reason for the dispute.
comment required	string <= 4000 characters The comment left when the dispute was created or the status or processing_status changed.
property name* additional property	any

Responses

Error Code	Description
body_not_matching_json_schema	Request body failed JSON schema validation.
invalid_data	Request body contains invalid JSON.
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
resource_not_found	Resource not found.

Error Code	Description
internal_error	An internal error has occurred.

Request samples

Payload

Content type

application/json

{"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!"
}

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}

Delete charge dispute

path Parameters

charge_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
dispute_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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

Error Code	Description
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
resource_not_found	Resource not found.

Error Code	Description
internal_error	An internal error has occurred.

Response samples

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

Update charge dispute

path Parameters

charge_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
dispute_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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

reason required	string Enum: "Buyer Does Not Recognize Charge" "Buyer Tax Exempt or Incorrect Tax" "Defective or Damaged Merchandise" "Duplicate PO or Transaction" "Incorrect or Missing Information" "Incorrect Invoice Date" "Incorrect Item" "Incorrect Price or Discount" "Services Not Rendered or Delivery Not Taken" "Transaction Billed To Wrong Buyer" "Manufacturers Warranty" "Misdirected Payment to 3rd Party" "Fraud/Unauthorized Purchase" "Transaction Paid To Client Direct" "Incorrect Seller Paid" "Other" The reason for the dispute.
comment required	string <= 4000 characters The comment left when the dispute was created or the status or processing_status changed.
property name* additional property	any

Responses

Error Code	Description
body_not_matching_json_schema	Request body failed JSON schema validation.
invalid_data	Request body contains invalid JSON.
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
resource_not_found	Resource not found.

Error Code	Description
internal_error	An internal error has occurred.

Request samples

Payload

Content type

application/json

{"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!"
}

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}

Accept charge dispute

path Parameters

charge_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
dispute_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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

comment

required

string <= 4000 characters

The comment left when the dispute was created or the status or processing_status changed.

Responses

Error Code	Description
body_not_matching_json_schema	Request body failed JSON schema validation.
invalid_data	Request body contains invalid JSON.
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
resource_not_found	Resource not found.

Error Code	Description
internal_error	An internal error has occurred.

Request samples

Payload

Content type

application/json

{"comment": "Have a nice day!"
}

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}

Cancel charge dispute

path Parameters

charge_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
dispute_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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

cancellation_reason required	string Enum: "Change Of Mind" "Incorrect Invoice Selected" "Miskey" "Resolved By The Merchant" "Other" The reason for canceling the dispute.
comment	string <= 4000 characters The comment left when the dispute was created or the status or processing_status changed.

Responses

Error Code	Description
body_not_matching_json_schema	Request body failed JSON schema validation.
invalid_data	Request body contains invalid JSON.
invalid_parameter	The value for the parameter is invalid.

Error Code	Description
unauthenticated	Authentication information is missing or invalid.

Error Code	Description
unauthorized	Permission to the requested resource is denied.

Error Code	Description
resource_not_found	Resource not found.

Request samples

Payload

Content type

application/json

{"cancellation_reason": "Change Of Mind",
"comment": "Have a nice day!"
}

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}

Decline charge dispute

path Parameters

charge_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
dispute_id required	string <uuid> Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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

comment

required

string <= 4000 characters

The comment left when the dispute was created or the status or processing_status changed.

Responses

Request samples

Payload

Content type

application/json

{"comment": "Have a nice day!"
}

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}

Charges

Get charge 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 charge resource ID.
charge_id	string <uuid> Example: charge_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge 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.
customer_group_id	Array of strings <uuid> [ items <uuid > ] Example: customer_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68&customer_group_id=8a1abdc0-9ea5-4006-9966-5f4a0720fbed The ID of the customer group the charge is related to.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer resource ID
buyer_id	string <uuid> Example: buyer_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The ID of the buyer user the charge is related to.
authorization_id	string <uuid> Example: authorization_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The ID of the authorization this charge should use.
transaction_type	string Enum: "Sale" "Credit" "Fee" "Reversal" Example: transaction_type=Sale The transaction type of the charge
invoice_id	string <uuid> Example: invoice_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The ID of the invoice the charge is related to.
invoice_number	string Example: invoice_number=3c87bd2b The invoice number for the charge. This may be missing if an invoice has not yet been generated.
invoice_generated_date	string <date> The date the invoice was generated.
invoice_due_date	string <date> The date the invoice is due
invoice_document_url	string <url> The URL of the invoice PDF document generated for the charge.
transaction_document_url	string <url> The URL transaction PDF document generated for the charge.
seller_tax_invoice_number	string <url> The seller tax invoice number provided with the charge.
seller_tax_invoice_document_url	string <url> The URL of the seller tax PDF document provided with the charge.
purchase_order_number	string Example: purchase_order_number=3c87bd2bdf9a The purchase order number provided for the charge.
order_number	string Example: order_number=0238dcacaf68 The order number provided for the charge.
order_url	string Example: order_url=0238dcacaf68 The order URL provided for the charge.
currency	string The transaction currency. One of the seller supported currencies.
customer_currency	string = 3 characters Example: customer_currency=USD The currency of the customer.
client_currency	string <= 3 characters Example: client_currency=USD Internal TreviPay client reporting currency.
system_currency	string <= 3 characters Example: system_currency=USD Internal TreviPay reporting currency.
	Array of objects The total amount of the charge in all related currencies. Excludes foreign exchange fee.
	Array of objects The total amount of the charge in all related currencies. Includes foreign exchange fee.
	Array of objects The total amount of tax in all related currencies.
	Array of objects The total amount unpaid.
	Array of objects The total amount that has been credited or refunded in all related currencies. Excludes returned foreign exchange fee amount.
	Array of objects The total amount that has been credited or refunded in all related currencies. Includes returned foreign exchange fee amount.
	Array of objects The total amount of deductions in all related currencies. This is the calculation of all credits plus adjusted amount for this charge.
	Array of objects The foreign exchange fee amount charged to the customer.
	Array of objects The foreign exchange fee amount returned to the customer.
in_dispute	boolean Whether the charge is currently in dispute.
can_dispute	boolean Whether the charge can be disputed.
status	string Enum: "Created" "Paid" "Pending" "Pending Payment" "Cancelled" "Rejected" Example: status=Created The status of the charge
status_detail	string Enum: "Adjusted" "Cancelled" "Credited" "Open" "Paid" "Paid Direct" "Partially Adjusted" "Past Due" "Pending" "Pending Payment" "Rejected" "Reversed" "Settled" The other status of the charge?
transaction_created_at	string <date-time> Examples: transaction_created_at=2019-01-01T23:59:59.999Z The timestamp the transaction was created.
processed_message_at	string <date-time> Examples: processed_message_at=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

200
400
401
403
500

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"authorization_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"transaction_type": "Sale",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_interval": "Sale",
"invoice_number": "3c87bd2b",
"invoice_generated_date": "2019-08-24",
"invoice_due_date": "2019-08-24",
"invoice_document_url": "string",
"transaction_document_url": "string",
"seller_tax_invoice_number": "string",
"seller_tax_invoice_document_url": "string",
"purchase_order_number": "3c87bd2bdf9a",
"order_number": "0238dcacaf68",
"order_url": "0238dcacaf68",
"currency": "string",
"customer_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"total": [{"currency": "string",
"amount": 0
}
],
"net_total": [{"currency": "string",
"amount": 0
}
],
"tax_total": [{"currency": "string",
"amount": 0
}
],
"open_total": [{"currency": "string",
"amount": 0
}
],
"return_total": [{"currency": "string",
"amount": 0
}
],
"net_return_total": [{"currency": "string",
"amount": 0
}
],
"deductions_total": [{"currency": "string",
"amount": 0
}
],
"foreign_exchange_fee_amount": [{"currency": "string",
"amount": 0
}
],
"return_foreign_exchange_fee_amount": [{"currency": "string",
"amount": 0
}
],
"in_dispute": true,
"can_dispute": true,
"status": "Created",
"status_detail": "Adjusted",
"transaction_created_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Get charge

path Parameters

charge_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique charge 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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"authorization_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"transaction_type": "Sale",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_interval": "Sale",
"invoice_number": "3c87bd2b",
"invoice_generated_date": "2019-08-24",
"invoice_due_date": "2019-08-24",
"invoice_document_url": "string",
"transaction_document_url": "string",
"seller_tax_invoice_number": "string",
"seller_tax_invoice_document_url": "string",
"purchase_order_number": "3c87bd2bdf9a",
"order_number": "0238dcacaf68",
"order_url": "0238dcacaf68",
"currency": "string",
"customer_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"total": [{"currency": "string",
"amount": 0
}
],
"net_total": [{"currency": "string",
"amount": 0
}
],
"tax_total": [{"currency": "string",
"amount": 0
}
],
"open_total": [{"currency": "string",
"amount": 0
}
],
"return_total": [{"currency": "string",
"amount": 0
}
],
"net_return_total": [{"currency": "string",
"amount": 0
}
],
"deductions_total": [{"currency": "string",
"amount": 0
}
],
"foreign_exchange_fee_amount": [{"currency": "string",
"amount": 0
}
],
"return_foreign_exchange_fee_amount": [{"currency": "string",
"amount": 0
}
],
"in_dispute": true,
"can_dispute": true,
"status": "Created",
"status_detail": "Adjusted",
"transaction_created_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Dispute Attachment Files

Get dispute attachment group collection

path Parameters

dispute_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique dispute 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=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique attachment group resource ID.
dispute_id	string <uuid> Example: dispute_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer 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.
title	string <= 50 characters The title of the attachment group.
description	string The description of the attachment group.
uploader_name	string <= 200 characters The name of the entity that uploaded the attachment group. This is the name of the 3Rivers user.
uploader_email	string <email> <= 200 characters The email of the entity that uploaded the attachment group. This could be the email of either a 3Rivers user or a Service Cloud user.
uploader_source	string Enum: "Application User" "Support User" "Application Integration" "Internal Integration" "Processing" The source of the entity that uploaded the attachment group.
uploader_source_id	string The ID of the source that uploaded the attachment group. This could be a 3Rivers user id, a Service Cloud user id, a Processing user id or an API Key id.
uploader_user_type	string Enum: "Support" "Client" "Customer" "Seller" The type of user that uploaded the attachment group.
status	string Enum: "Active" "Deleted" Example: status=Active The status of the attachment group
deleted_at	string <date-time> Examples: deleted_at=2019-01-01T23:59:59.999Z The timestamp indicating when the attachment group was deleted.
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

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"title": "string",
"description": "string",
"uploader_name": "string",
"uploader_email": "user@example.com",
"uploader_source": "Application User",
"uploader_source_id": "string",
"uploader_user_type": "Support",
"status": "Active",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Create dispute attachment group

path Parameters

dispute_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique dispute 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

title required	string <= 50 characters The title of the attachment group.
description required	string The description of the attachment group.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string"
}

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"title": "string",
"description": "string",
"uploader_name": "string",
"uploader_email": "user@example.com",
"uploader_source": "Application User",
"uploader_source_id": "string",
"uploader_user_type": "Support",
"status": "Active",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Get dispute attachment group

path Parameters

dispute_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique dispute 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",
"dispute_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"title": "string",
"description": "string",
"uploader_name": "string",
"uploader_email": "user@example.com",
"uploader_source": "Application User",
"uploader_source_id": "string",
"uploader_user_type": "Support",
"status": "Active",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Download dispute attachment group file collection

path Parameters

attachment_group_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique attachment group 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

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

Get dispute attachment group files

path Parameters

attachment_group_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique attachment group 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=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique file resource ID.
attachment_group_id	string <uuid> Example: attachment_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique attachment group 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.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer 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 The name of the file.
extension_type	string Enum: "pdf" "csv" "txt" "jpg" "jpeg" "png" "gif" "tif" "tiff" The extension type 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.
status	string Enum: "Processing" "Processed" "Error" The status of the file
deleted_at	string <date-time> Examples: deleted_at=2019-01-01T23:59:59.999Z The timestamp indicating when the file was deleted.
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

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"attachment_group_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"name": "string",
"extension_type": "pdf",
"processed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"error_at": "2019-08-24T14:15:22Z",
"status": "Processing",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Create dispute attachment group file

path Parameters

attachment_group_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique attachment group 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",
"attachment_group_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"name": "string",
"extension_type": "pdf",
"processed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"error_at": "2019-08-24T14:15:22Z",
"status": "Processing",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Get dispute attachment group file

path Parameters

attachment_group_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique attachment group 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",
"attachment_group_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"name": "string",
"extension_type": "pdf",
"processed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"error_at": "2019-08-24T14:15:22Z",
"status": "Processing",
"deleted_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Download dispute attachment group file

path Parameters

attachment_group_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique attachment group 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

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

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.
onboarding_group_id	string <uuid> Example: onboarding_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique customer onboarding group resource ID.
name	string [ 1 .. 1024 ] characters Optional name for the customer
currency	string = 3 characters Example: currency=USD The currency of the customer.
country	string = 2 characters Example: country=US The country of the customer.
invoice_type	string [ 1 .. 20 ] characters Example: invoice_type=Transactional The invoice type the customer is set up for.
bill_cycle	string [ 1 .. 200 ] characters Example: bill_cycle=Daily Customers billing cycle. Defines how often a customer is billed.
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_at	string <date-time> Examples: processed_message_at=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

[{"id": "d1363171-4587-4f8d-b276-977691e4a925",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "2019-01-01T23:59:59.999Z"
}
]

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.

Request Body schema: application/json

name	string [ 1 .. 1024 ] characters Optional name for the customer
currency	string = 3 characters The currency of the customer.
country	string = 2 characters The country of the customer.
invoice_type	string [ 1 .. 20 ] characters The invoice type the customer is set up for.
bill_cycle	string [ 1 .. 200 ] characters Customers billing cycle. Defines how often a customer is billed.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily"
}

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",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "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.

Responses

Response samples

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

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",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "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.

Request Body schema: application/json

name	string [ 1 .. 1024 ] characters Optional name for the customer
currency	string = 3 characters The currency of the customer.
country	string = 2 characters The country of the customer.
invoice_type	string [ 1 .. 20 ] characters The invoice type the customer is set up for.
bill_cycle	string [ 1 .. 200 ] characters Customers billing cycle. Defines how often a customer is billed.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily"
}

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",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "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.

Request Body schema: application/json

name	string [ 1 .. 1024 ] characters Optional name for the customer
currency	string = 3 characters The currency of the customer.
country	string = 2 characters The country of the customer.
invoice_type	string [ 1 .. 20 ] characters The invoice type the customer is set up for.
bill_cycle	string [ 1 .. 200 ] characters Customers billing cycle. Defines how often a customer is billed.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily"
}

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",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "2019-01-01T23:59:59.999Z"
}

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_at	string <date-time> Examples: processed_message_at=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

[{"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_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

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.

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

Payload

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_at": "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_at": "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.

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

Payload

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_at": "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.

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

Payload

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_at": "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.
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 program resource ID.
name	string [ 1 .. 1024 ] characters Examples: name=Apruve name=BestBuy name=Lenovo The name of the program.
program_type	any Enum: "Sandbox" "Live" The type of program
program_currency	string <= 3 characters Example: program_currency=USD Internal TreviPay client program reporting currency.
client_currency	string <= 3 characters Example: client_currency=USD Internal TreviPay client reporting currency.
system_currency	string <= 3 characters Example: system_currency=USD Internal TreviPay reporting currency.
dispute_email	string <= 200 characters
reply_to_email	string <= 200 characters
support_email	string <= 200 characters
sender_email	string <= 200 characters
status	any Enum: "Created" "Active" "Inactive" "Terminated" "Archived" Current status of the program.
dispute_eligibility_days	integer [ 1 .. 180 ] The period of time after a charge is created that it may be disputed.
dispute_timeout_days	integer [ 1 .. 180 ] The period of time a client has to action a dispute once it has been raised by a customer.
processed_message_at	string <date-time> Examples: processed_message_at=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
is_universal_acceptance_enabled	boolean Whether the program is enabled for universal acceptance.
has_consolidated_billing	boolean Whether the program supports consolidated billing.
decline_without_attachment	boolean Whether the program allows disputes to be declined without an attachment.
raise_without_attachment	boolean Whether the program allows disputes to be raised without an attachment.
raise_dispute_with_contact_prompt	boolean Whether the program allows disputes to be raised with a contact prompt.
	null or string or string The email address of the contact in the prompt before raising dispute.
dispute_contact_phone	string <= 200 characters The phone number of the contact in the prompt before raising dispute.
dispute_contact_url	string <= 200 characters The URL of the contact in the prompt before raising dispute.
dispute_contact_text_display	string <= 200 characters The text display of the dispute contact URL in the prompt before raising dispute.
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

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

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.

Request Body schema: application/json

name required	string [ 1 .. 1024 ] characters The name of the program.
program_currency required	string <= 3 characters Internal TreviPay client program reporting currency.
client_currency required	string <= 3 characters Internal TreviPay client reporting currency.
system_currency required	string <= 3 characters Internal TreviPay reporting currency.
dispute_email required	string <idn-email> <= 200 characters Dispute email.
reply_to_email required	string <idn-email> <= 200 characters Reply to email.
support_email required	string <idn-email> <= 200 characters Support email.
sender_email required	string <idn-email> <= 200 characters Sender email.
status required	any Enum: "Created" "Active" "Inactive" "Terminated" "Archived" Current status of the program.
dispute_eligibility_days required	integer [ 1 .. 180 ] The period of time after a charge is created that it may be disputed.
dispute_timeout_days required	integer [ 1 .. 180 ] The period of time a client has to action a dispute once it has been raised by a customer.
is_universal_acceptance_enabled	boolean Whether the program is enabled for universal acceptance.
has_consolidated_billing	boolean Whether the program supports consolidated billing.
decline_without_attachment	boolean Whether the program allows disputes to be declined without an attachment.
raise_without_attachment	boolean Whether the program allows disputes to be raised without an attachment.
raise_dispute_with_contact_prompt	boolean Whether the program allows disputes to be raised with a contact prompt.
	null or string or string The email address of the contact in the prompt before raising dispute.
dispute_contact_phone	string <= 200 characters The phone number of the contact in the prompt before raising dispute.
dispute_contact_url	string <= 200 characters The URL of the contact in the prompt before raising dispute.
dispute_contact_text_display	string <= 200 characters The text display of the dispute contact URL in the prompt before raising dispute.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "Apruve",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string"
}

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"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.

Responses

Response samples

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

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",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"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.

Request Body schema: application/json

name required	string [ 1 .. 1024 ] characters The name of the program.
program_currency required	string <= 3 characters Internal TreviPay client program reporting currency.
client_currency required	string <= 3 characters Internal TreviPay client reporting currency.
system_currency required	string <= 3 characters Internal TreviPay reporting currency.
dispute_email required	string <idn-email> <= 200 characters Dispute email.
reply_to_email required	string <idn-email> <= 200 characters Reply to email.
support_email required	string <idn-email> <= 200 characters Support email.
sender_email required	string <idn-email> <= 200 characters Sender email.
status required	any Enum: "Created" "Active" "Inactive" "Terminated" "Archived" Current status of the program.
dispute_eligibility_days required	integer [ 1 .. 180 ] The period of time after a charge is created that it may be disputed.
dispute_timeout_days required	integer [ 1 .. 180 ] The period of time a client has to action a dispute once it has been raised by a customer.
is_universal_acceptance_enabled	boolean Whether the program is enabled for universal acceptance.
has_consolidated_billing	boolean Whether the program supports consolidated billing.
decline_without_attachment	boolean Whether the program allows disputes to be declined without an attachment.
raise_without_attachment	boolean Whether the program allows disputes to be raised without an attachment.
raise_dispute_with_contact_prompt	boolean Whether the program allows disputes to be raised with a contact prompt.
	null or string or string The email address of the contact in the prompt before raising dispute.
dispute_contact_phone	string <= 200 characters The phone number of the contact in the prompt before raising dispute.
dispute_contact_url	string <= 200 characters The URL of the contact in the prompt before raising dispute.
dispute_contact_text_display	string <= 200 characters The text display of the dispute contact URL in the prompt before raising dispute.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "Apruve",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string"
}

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"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.

Request Body schema: application/json

name required	string [ 1 .. 1024 ] characters The name of the program.
program_currency required	string <= 3 characters Internal TreviPay client program reporting currency.
client_currency required	string <= 3 characters Internal TreviPay client reporting currency.
system_currency required	string <= 3 characters Internal TreviPay reporting currency.
dispute_email required	string <idn-email> <= 200 characters Dispute email.
reply_to_email required	string <idn-email> <= 200 characters Reply to email.
support_email required	string <idn-email> <= 200 characters Support email.
sender_email required	string <idn-email> <= 200 characters Sender email.
status required	any Enum: "Created" "Active" "Inactive" "Terminated" "Archived" Current status of the program.
dispute_eligibility_days required	integer [ 1 .. 180 ] The period of time after a charge is created that it may be disputed.
dispute_timeout_days required	integer [ 1 .. 180 ] The period of time a client has to action a dispute once it has been raised by a customer.
is_universal_acceptance_enabled	boolean Whether the program is enabled for universal acceptance.
has_consolidated_billing	boolean Whether the program supports consolidated billing.
decline_without_attachment	boolean Whether the program allows disputes to be declined without an attachment.
raise_without_attachment	boolean Whether the program allows disputes to be raised without an attachment.
raise_dispute_with_contact_prompt	boolean Whether the program allows disputes to be raised with a contact prompt.
	null or string or string The email address of the contact in the prompt before raising dispute.
dispute_contact_phone	string <= 200 characters The phone number of the contact in the prompt before raising dispute.
dispute_contact_url	string <= 200 characters The URL of the contact in the prompt before raising dispute.
dispute_contact_text_display	string <= 200 characters The text display of the dispute contact URL in the prompt before raising dispute.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "Apruve",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string"
}

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"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.

Responses

Response samples

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

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_at	string <date-time> Examples: processed_message_at=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

200
400
401
403
500

Content type

application/json

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Create client

header Parameters

Authorization

required

string <uuid> (Authorization Header)

Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Request Body schema: application/json

name required	string [ 1 .. 1024 ] characters The name of the client.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "Apruve"
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"processed_message_at": "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.

Responses

Response samples

400
401
403
404
500

Content type

application/json

[{"code": "invalid_customer_countries",
"message": "Request body failed JSON schema validation.",
"validationErrors": [ ]
}
]

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_at": "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.

Request Body schema: application/json

name required	string [ 1 .. 1024 ] characters The name of the client.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "Apruve"
}

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"processed_message_at": "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.

Request Body schema: application/json

name required	string [ 1 .. 1024 ] characters The name of the client.
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "Apruve"
}

Response samples

Content type

application/json

{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Customer Onboarding Groups

Get program customer onboarding group 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.
name	string [ 1 .. 1024 ] characters Examples: name=Onboarding Group The name of the program customer onboarding group.
is_enabled_for_invitations	boolean Controls if this group should be available when manually inviting a single customer.
is_enabled_for_remittance	boolean Controls if the previous remittance bank account associated with this group should be shown to customers.
is_misdirected_payment_dispute_reason_enabled	boolean Controls if is TRUE then the reason 'Paid to 3rd Party Terms Provider Directly' should be visible within the dispute service
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

200
400
401
403
500

Content type

application/json

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Onboarding Group",
"is_enabled_for_invitations": true,
"is_enabled_for_remittance": true,
"is_misdirected_payment_dispute_reason_enabled": true,
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Get customer onboarding group

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",
"name": "Onboarding Group",
"is_enabled_for_invitations": true,
"is_enabled_for_remittance": true,
"is_misdirected_payment_dispute_reason_enabled": true,
"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.
onboarding_group_id	string <uuid> Example: onboarding_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique customer onboarding group resource ID.
name	string [ 1 .. 1024 ] characters Optional name for the customer
currency	string = 3 characters Example: currency=USD The currency of the customer.
country	string = 2 characters Example: country=US The country of the customer.
invoice_type	string [ 1 .. 20 ] characters Example: invoice_type=Transactional The invoice type the customer is set up for.
bill_cycle	string [ 1 .. 200 ] characters Example: bill_cycle=Daily Customers billing cycle. Defines how often a customer is billed.
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_at	string <date-time> Examples: processed_message_at=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

200
400
401
403
500

Content type

application/json

[{"id": "d1363171-4587-4f8d-b276-977691e4a925",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "2019-01-01T23:59:59.999Z"
}
]

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",
"onboarding_group_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "string",
"currency": "USD",
"country": "US",
"invoice_type": "Transactional",
"bill_cycle": "Daily",
"created_at": "2019-01-01",
"updated_at": "2019-01-01",
"processed_message_at": "2019-01-01T23:59:59.999Z"
}

Dispute History

Get dispute 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=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute history resource ID.
dispute_history_id	string <uuid> Example: dispute_history_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute history 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.
customer_group_id	Array of strings <uuid> [ items <uuid > ] Example: customer_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68&customer_group_id=8a1abdc0-9ea5-4006-9966-5f4a0720fbed The ID of the customer group the charge is related to.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer resource ID
buyer_id	string <uuid> Example: buyer_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The ID of the buyer user the charge is related to.
charge_id	string <uuid> Example: charge_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
dispute_id	string <uuid> Example: dispute_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute resource ID.
comment	string <= 4000 characters Example: comment=Have a nice day! The comment left when the dispute was created or the status or processing_status changed.
status	string Enum: "Open" "Closed" "Draft" "Expired" "Declined" "Accepted" Example: status=Open The status of the dispute
actioned_at	string <date-time> Examples: actioned_at=2019-01-01T23:59:59.999Z The timestamp indicating when an action occurred on the dispute.
processing_status	string Enum: "Awaiting Attachment" "Awaiting Payment" "Awaiting Refund" "Canceled" "Chargeback - Customer Non-Payment" "Chargeback - Refund Expiry" "Chargeback - Resolution Timeout" "Misdirected Automations" "Open" "Payment Received" "Refund Expiry" "Refunded" Example: processing_status=Open The processing status of the dispute.
last_updated_user_type	string Enum: "Support" "Client" "Customer" "Seller" The type of user that last updated the dispute.
last_updated_source	string Enum: "Application User" "Support User" "Application Integration" "Internal Integration" "Processing" The source of the entity that last updated the dispute.
last_updated_source_id	string The ID of the source that last updated the dispute. This could be a 3Rivers user id, a Service Cloud user id, a Processing user id or an API Key id.
last_updated_name	string <= 200 characters The name of the entity that last updated the dispute. This is the name of the 3Rivers user.
last_updated_email	string <email> <= 200 characters The email of the entity that last updated the dispute. This could be the email of either a 3Rivers user or a Service Cloud user.
processed_message_at	string <date-time> Examples: processed_message_at=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

200
400
401
403
500

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"comment": "Have a nice day!",
"status": "Open",
"actioned_at": "2019-01-01T23:59:59.999Z",
"processing_status": "Open",
"last_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_source": "Application User",
"last_updated_source_id": "string",
"last_updated_user_type": "Support",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Get dispute history

path Parameters

dispute_history_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique dispute history 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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"comment": "Have a nice day!",
"status": "Open",
"actioned_at": "2019-01-01T23:59:59.999Z",
"processing_status": "Open",
"last_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_source": "Application User",
"last_updated_source_id": "string",
"last_updated_user_type": "Support",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

Disputes

Get dispute 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 dispute resource ID.
dispute_id	string <uuid> Example: dispute_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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.
customer_group_id	Array of strings <uuid> [ items <uuid > ] Example: customer_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68&customer_group_id=8a1abdc0-9ea5-4006-9966-5f4a0720fbed The ID of the customer group the charge is related to.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer resource ID
buyer_id	string <uuid> Example: buyer_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The ID of the buyer user the charge is related to.
charge_id	string <uuid> Example: charge_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique charge resource ID.
invoice_id	string <uuid> Example: invoice_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The ID of the invoice the charge is related to.
first_updated_source_id	string The ID of the source that first updated the dispute. This could be a 3Rivers user id, a Service Cloud user id, a Processing user id or an API Key id.
last_updated_source_id	string The ID of the source that last updated the dispute. This could be a 3Rivers user id, a Service Cloud user id, a Processing user id or an API Key id.
client_name	string [ 1 .. 1024 ] characters Examples: client_name=Apruve client_name=BestBuy client_name=Lenovo The name of the client.
program_name	string [ 1 .. 1024 ] characters Examples: program_name=Apruve program_name=BestBuy program_name=Lenovo The name of the program.
customer_name	string [ 1 .. 1024 ] characters Optional name for the customer
seller_name	string [ 1 .. 1024 ] characters Examples: seller_name=Apruve seller_name=BestBuy seller_name=Lenovo The name of the seller.
first_updated_name	string <= 200 characters The name of the entity that first updated the dispute. This is the name of the 3Rivers user.
first_updated_email	string <email> <= 200 characters The email of the entity that first updated the dispute. This could be the email of either a 3Rivers user or a Service Cloud user.
last_updated_name	string <= 200 characters The name of the entity that last updated the dispute. This is the name of the 3Rivers user.
last_updated_email	string <email> <= 200 characters The email of the entity that last updated the dispute. This could be the email of either a 3Rivers user or a Service Cloud user.
order_number	string Example: order_number=0238dcacaf68 The order number provided for the charge.
purchase_order_number	string Example: purchase_order_number=3c87bd2bdf9a The purchase order number provided for the charge.
invoice_number	string Example: invoice_number=3c87bd2b The invoice number for the charge. This may be missing if an invoice has not yet been generated.
invoice_document_url	string <url> The URL of the invoice PDF document generated for the charge.
transaction_document_url	string <url> The URL transaction PDF document generated for the charge.
customer_currency	string = 3 characters Example: customer_currency=USD The currency of the customer.
transaction_currency	string The transaction currency. One of the seller supported currencies.
reason	string Enum: "Buyer Does Not Recognize Charge" "Buyer Tax Exempt or Incorrect Tax" "Defective or Damaged Merchandise" "Duplicate PO or Transaction" "Incorrect or Missing Information" "Incorrect Invoice Date" "Incorrect Item" "Incorrect Price or Discount" "Services Not Rendered or Delivery Not Taken" "Transaction Billed To Wrong Buyer" "Manufacturers Warranty" "Misdirected Payment to 3rd Party" "Fraud/Unauthorized Purchase" "Transaction Paid To Client Direct" "Incorrect Seller Paid" "Other" The reason for the dispute.
comment	string <= 4000 characters Example: comment=Have a nice day! The comment left when the dispute was created or the status or processing_status changed.
first_comment	string <= 4000 characters Example: first_comment=Have a nice day! The comment left when the dispute was created.
status	string Enum: "Open" "Closed" "Draft" "Expired" "Declined" "Accepted" Example: status=Open The status of the dispute
decision	string Enum: "Accepted" "Acknowledged" "Declined" "No Decision" "Not Applicable" "Not Required" "Pending" The decision of the dispute. For new disputes, this value is Pending and is updated during the dispute resolution process once the dispute is considered resolved. For draft disputes, this value is Not Applicable.
processing_status	string Enum: "Awaiting Attachment" "Awaiting Payment" "Awaiting Refund" "Canceled" "Chargeback - Customer Non-Payment" "Chargeback - Refund Expiry" "Chargeback - Resolution Timeout" "Misdirected Automations" "Open" "Payment Received" "Refund Expiry" "Refunded" Example: processing_status=Open The processing status of the dispute.
first_updated_user_type	string Enum: "Support" "Client" "Customer" "Seller" The type of user that first updated the dispute.
first_updated_source	string Enum: "Application User" "Support User" "Application Integration" "Internal Integration" "Processing" The source of the entity that first updated the dispute.
last_updated_user_type	string Enum: "Support" "Client" "Customer" "Seller" The type of user that last updated the dispute.
last_updated_source	string Enum: "Application User" "Support User" "Application Integration" "Internal Integration" "Processing" The source of the entity that last updated the dispute.
invoice_interval	string Enum: "Daily" "Monthly" "Transactional" "TwiceMonthly" "Weekly" Example: invoice_interval=Sale The invoice interval for the customer at the time the charge occurred.
dispute_timeout_days	integer [ 1 .. 180 ] The period of time a client has to action a dispute once it has been raised by a customer.
	Array of objects The total amount of the charge in all related currencies. Includes foreign exchange fee.
customer_net_total	integer The net total of the dispute in the customer's currency. It is the lowest denomination for the currency (e.g. cents for US Dollars).
transaction_net_total	integer The net total of the dispute in the transaction currency. It is the lowest denomination for the currency (e.g. cents for US Dollars).
expires_at	string <date-time> Examples: expires_at=2019-01-01T23:59:59.999Z The date when this dispute expires.
actioned_at	string <date-time> Examples: actioned_at=2019-01-01T23:59:59.999Z The timestamp indicating when an action occurred on the dispute.
first_actioned_at	string <date-time> Examples: first_actioned_at=2019-01-01T23:59:59.999Z The timestamp indicating when the first action occurred on the dispute.
processed_message_at	string <date-time> Examples: processed_message_at=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
resolved_at	string <date-time> Examples: resolved_at=2019-01-01T23:59:59.999Z The timestamp when a dispute is considered resolved. This is the first time that the dispute is Accepted, Declined, or Expired.
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

200
400
401
403
500

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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}
]

Get dispute

path Parameters

dispute_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

Unique dispute 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",
"customer_group_id": ["3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"8a1abdc0-9ea5-4006-9966-5f4a0720fbed"
],
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"buyer_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"charge_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"invoice_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"first_updated_source_id": "string",
"last_updated_source_id": "string",
"client_name": "Apruve",
"program_name": "Apruve",
"customer_name": "string",
"seller_name": "Apruve",
"first_updated_name": "string",
"first_updated_email": "user@example.com",
"last_updated_name": "string",
"last_updated_email": "user@example.com",
"order_number": "0238dcacaf68",
"purchase_order_number": "3c87bd2bdf9a",
"invoice_number": "3c87bd2b",
"invoice_document_url": "string",
"transaction_document_url": "string",
"invoice_due_date": "2019-08-24",
"customer_currency": "USD",
"transaction_currency": "string",
"reason": "Buyer Does Not Recognize Charge",
"comment": "Have a nice day!",
"cancellation_reason": "Change Of Mind",
"cancellation_comment": "Have a nice day!",
"first_comment": "Have a nice day!",
"status": "Open",
"decision": "Accepted",
"processing_status": "Open",
"first_updated_user_type": "Support",
"first_updated_source": "Application User",
"last_updated_user_type": "Support",
"last_updated_source": "Application User",
"invoice_interval": "Sale",
"dispute_timeout_days": 1,
"net_total": [{"currency": "string",
"amount": 0
}
],
"customer_net_total": 0,
"transaction_net_total": 0,
"expires_at": "2019-01-01T23:59:59.999Z",
"actioned_at": "2019-01-01T23:59:59.999Z",
"first_actioned_at": "2019-01-01T23:59:59.999Z",
"processed_message_at": "2019-01-01T23:59:59.999Z",
"resolved_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"previous_status": "Open",
"updated_at": "2019-01-01"
}

Files

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=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique file resource ID.
attachment_group_id	string <uuid> Example: attachment_group_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique attachment group 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.
customer_id	string <uuid> Example: customer_id=d1363171-4587-4f8d-b276-977691e4a925 Unique customer 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 The name of the file.
extension_type	string Enum: "pdf" "csv" "txt" "jpg" "jpeg" "png" "gif" "tif" "tiff" The extension type 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.
status	string Enum: "Processing" "Processed" "Error" The status of the file
deleted_at	string <date-time> Examples: deleted_at=2019-01-01T23:59:59.999Z The timestamp indicating when the file was deleted.
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

200
400
401
403
500

Content type

application/json

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"attachment_group_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"name": "string",
"extension_type": "pdf",
"processed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"error_at": "2019-08-24T14:15:22Z",
"status": "Processing",
"deleted_at": "2019-01-01T23:59:59.999Z",
"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": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"attachment_group_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",
"customer_id": "d1363171-4587-4f8d-b276-977691e4a925",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"name": "string",
"extension_type": "pdf",
"processed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"error_at": "2019-08-24T14:15:22Z",
"status": "Processing",
"deleted_at": "2019-01-01T23:59:59.999Z",
"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.
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 program resource ID.
name	string [ 1 .. 1024 ] characters Examples: name=Apruve name=BestBuy name=Lenovo The name of the program.
program_type	any Enum: "Sandbox" "Live" The type of program
program_currency	string <= 3 characters Example: program_currency=USD Internal TreviPay client program reporting currency.
client_currency	string <= 3 characters Example: client_currency=USD Internal TreviPay client reporting currency.
system_currency	string <= 3 characters Example: system_currency=USD Internal TreviPay reporting currency.
dispute_email	string <= 200 characters
reply_to_email	string <= 200 characters
support_email	string <= 200 characters
sender_email	string <= 200 characters
status	any Enum: "Created" "Active" "Inactive" "Terminated" "Archived" Current status of the program.
dispute_eligibility_days	integer [ 1 .. 180 ] The period of time after a charge is created that it may be disputed.
dispute_timeout_days	integer [ 1 .. 180 ] The period of time a client has to action a dispute once it has been raised by a customer.
processed_message_at	string <date-time> Examples: processed_message_at=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
is_universal_acceptance_enabled	boolean Whether the program is enabled for universal acceptance.
has_consolidated_billing	boolean Whether the program supports consolidated billing.
decline_without_attachment	boolean Whether the program allows disputes to be declined without an attachment.
raise_without_attachment	boolean Whether the program allows disputes to be raised without an attachment.
raise_dispute_with_contact_prompt	boolean Whether the program allows disputes to be raised with a contact prompt.
	null or string or string The email address of the contact in the prompt before raising dispute.
dispute_contact_phone	string <= 200 characters The phone number of the contact in the prompt before raising dispute.
dispute_contact_url	string <= 200 characters The URL of the contact in the prompt before raising dispute.
dispute_contact_text_display	string <= 200 characters The text display of the dispute contact URL in the prompt before raising dispute.
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

200
400
401
403
500

Content type

application/json

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"name": "Apruve",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

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",
"program_type": "Sandbox",
"program_currency": "USD",
"client_currency": "USD",
"system_currency": "USD",
"dispute_email": "пошта@укр.нет",
"reply_to_email": "пошта@укр.нет",
"sender_email": "пошта@укр.нет",
"support_email": "пошта@укр.нет",
"status": "Created",
"dispute_eligibility_days": 1,
"dispute_timeout_days": 1,
"processed_message_at": "2019-01-01T23:59:59.999Z",
"is_universal_acceptance_enabled": true,
"has_consolidated_billing": true,
"decline_without_attachment": true,
"raise_without_attachment": true,
"raise_dispute_with_contact_prompt": true,
"dispute_contact_email": { },
"dispute_contact_phone": "string",
"dispute_contact_url": "string",
"dispute_contact_text_display": "string",
"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_at	string <date-time> Examples: processed_message_at=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

200
400
401
403
500

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_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

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_at": "2019-01-01T23:59:59.999Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

SNS Message

Get SNS 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=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The record ID for the SNS message.
sns_message_id	string <uuid> Example: sns_message_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 The record ID for the SNS message.
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.
dispute_id	string <uuid> Example: dispute_id=3c87bd2b-df9a-413b-94ab-0238dcacaf68 Unique dispute 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.
message_id	string The message id returned by SNS for the message.
message_subject	string The subject of the message.
message_topic_arn	string The ARN of the SNS topic to which the message is to be published.
message	string The message to be published.
status	string The status of the SNS message.
error_log	string non-empty The error log is populated when the SNS 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 SNS message record has failed.
failed_at	string <date-time> Date/time the SNS message processing last failed.
published_at	string <date-time> Date/time the SNS message was published.
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

200
400
401
403
500

Content type

application/json

[{"id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"message_id": "string",
"message_subject": "string",
"message_topic_arn": "string",
"message_group_id": "string",
"message": "string",
"message_attributes": "string",
"status": "string",
"error_log": "string",
"failure_count": 0,
"failed_at": "2019-08-24T14:15:22Z",
"published_at": "2019-08-24T14:15:22Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

Get SNS Message

path Parameters

sns_message_id

required

string <uuid>

Example: 3c87bd2b-df9a-413b-94ab-0238dcacaf68

The record ID for the SNS 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": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"dispute_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
"correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
"message_id": "string",
"message_subject": "string",
"message_topic_arn": "string",
"message_group_id": "string",
"message": "string",
"message_attributes": "string",
"status": "string",
"error_log": "string",
"failure_count": 0,
"failed_at": "2019-08-24T14:15:22Z",
"published_at": "2019-08-24T14:15:22Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}

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 record ID and the unique id assigned by SQS to a message.
sqs_message_id	string <uuid> Example: sqs_message_id=e86f4f0d-329d-42a7-be3e-f13ef305d111 The record ID and 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

200
400
401
403
500

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",
"retry_count": 0,
"retry_at": "2019-08-24T14:15:22Z",
"failure_count": 0,
"failed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"processed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}
]

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",
"retry_count": 0,
"retry_at": "2019-08-24T14:15:22Z",
"failure_count": 0,
"failed_at": "2019-08-24T14:15:22Z",
"error_log": "string",
"processed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-01-01",
"updated_at": "2019-01-01"
}