Download OpenAPI specification:Download
Enhance your understanding with our detailed Business Guide.
Support: support@chargebackhit.com
Chargebackhit provides API that empowers you to process and manage alerts. Chargebackhit APIs accept and return JSON in the HTTP body. You can interact with the APIs directly using your preferred HTTP/REST library or leverage one of ours.
Great care is taken to ensure that changes to the APIs do not impact existing integrations. Below are the types of changes considered to be backward-compatible:
For non-ordered events, adopt practices like temporarily storing webhooks before processing, using Chargebackhit's API for additional data in case of event collisions, and processing events asynchronously to avoid timeout issues.
When you sign up for an account, you are given a secret and public API key pair. You authenticate with our API by providing the appropriate key in the request Authorization header. Never share your secret keys. Keep them guarded and secure.
To start accepting alerts, even in the sandbox environment, you need credentials. You can easily find your credentials in the admin panel. The signature value is base64-encoded from the SHA-512 hash function. Apply the merchant's secret key for the encryption key, and use the following string for signature data:base64encode(sha512(public_key + requestJsonData + public_key))
To access the detailed information mentioned above, navigate to guide.
The Chargebackhit provides the following main requests for testing integration:
Both requests offer appropriate response codes to help users identify successful integrations, bad requests, or unauthorized access.
The primary purpose of this request is to support the testing and validation of Chargebackhit integrations in a controlled environment. The request aims to create simulated alerts for testing purposes. This request ensures secure communication through the use of request signatures and public keys. It contains comprehensive information about the alert.
The request also gathers essential card-related details, such as the card acceptor ID, etc. Additionally, it encompasses merchant details, including their identification, name, and payment descriptor.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object All information about the alert. | |
object Associated with the alert transaction data. Used for matching alert to transaction. | |
object Information about the MID. |
{- "alert": {
- "id": "pal-1ed9d459-3f17-4a10-be7d-a09360154a29",
- "date": "2023-02-20T14:15:22Z",
- "provider": "verifi",
- "product": "oi",
- "type": "inquiry",
- "outcome": "acknowledged",
- "card_acceptor_id": "000000000554111",
- "acquirer_bin": "444111",
- "amount": "10.00",
- "currency": "USD",
- "reason_group": "fraud",
- "rdr": {
- "status": "declined",
- "rule": "This rule will accept all RDR cases above 0.01"
}
}, - "transaction": {
- "transaction_merchant_id": "f150ed65-e5fd-4309-a612-a5f4f84f6071",
- "transaction_id": "633042476707421",
- "date": "2023-01-01T14:15:22Z",
- "amount": "10.00",
- "currency": "USD",
- "type": "sale",
- "card_brand": "VISA",
- "bin": "411111",
- "last_four": "1111",
- "auth_code": "00251",
- "arn": "24871153022084127852235"
}, - "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}
}
{- "error": {
- "code": "validation",
- "message": "Validation error",
- "constraints": {
- "field": [
- {
- "code": "not_null",
- "message": "not_null"
}
]
}
}
}
The primary purpose of the request is to facilitate effective communication of chargeback and outcomes while ensuring secure and accurate data sharing. The request is designed to process and communicate the outcome of a chargeback.
The request encompasses detailed information about the order, refund, customer, device, transactions, products, and merchant, including various identifiers, dates, amounts, currencies, and contact details. It also covers relevant URLs related to the merchant's policies and terms.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
outcome required | string Enum: "reversed" "previously-reversed" "duplicate" "decline" "reverse-error" … 4 more Standard required response codes.
|
object It contains all the information available for the order. | |
object The customer information parameters are a set of user identifiers you share alongside your order information. | |
Array of objects It contains all the information available for the related transactions. | |
Array of objects Additional information of the products that was purchased. | |
object Information about the merchant, their contacts, policies, and so on. |
{- "outcome": "reversed",
- "order": {
- "order_id": "3235354",
- "date": "2014-11-01T14:15:22Z",
- "amount": "19.99",
- "currency": "USD",
- "address": {
- "address1": "94 Mayflower Street Bronx",
- "address2": "Apt 2B",
- "city": "New York",
- "postal_code": "10001",
- "region": "NY",
- "country": "USA"
}, - "refund": {
- "amount": "19.99",
- "currency": "USD",
- "date": "2014-11-01T14:15:22Z"
}
}, - "customer": {
- "first_name": "John",
- "last_name": "Doe",
- "date_of_birth": "1985-11-01T14:15:22Z",
- "customer_id": "JD123458932",
- "first_transaction_date": "2014-11-01T14:15:22Z",
- "length_of_relationship": "5 years",
- "authentication_used": "johndoe@mail.com",
- "phone": "+1234567890",
- "email": "johndoe@mail.com",
- "device": {
- "name": "Johns Phone",
- "identifier": "12313212-asdfa-123123",
- "location": "New York",
- "ip_address": "192.168.50.123"
}
}, - "transactions": [
- {
- "date": "2014-11-01T14:15:22Z",
- "currency": "USD",
- "amount": "19.99",
- "bin": "123456",
- "last_four": "1114",
- "transaction_merchant_id": "3235312",
- "transaction_id": "201409338",
- "type": "sale",
- "recurring_transaction": "monthly"
}
], - "products": [
- {
- "name": "Z 12 Month Antivirus Protection 1",
- "sku": "16309",
- "description": "12 month premium antivirus for Windows",
- "quantity": "1",
- "notes": "Includes free monthly security updates"
}
], - "merchant": {
}
}
{- "error": {
- "code": "validation",
- "message": "Validation error",
- "constraints": {
- "field": [
- {
- "code": "not_null",
- "message": "not_null"
}
]
}
}
}
This section ensures seamless and efficient management of alerts and outcomes within the Chargebackhit.
Update response outcome allows for efficient and secure updates of alert outcomes, ensuring up-to-date information. Get alert by ID facilitates secure access to detailed information about a specific alert, while Alert list enables users to securely and effectively retrieve tailored lists of alerts based on various filtering parameters.
This request facilitates efficient and secure updating of alert outcomes within the Chargebackhit.
The primary purpose of a request in the Chargebackhit is to update the outcome of a previously submitted alert. This request allows users to provide an updated response outcome for a specific alert identified by its unique identifier (UUID).
id required | string <uuid> The identifier. |
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object It contains all the information available for the order. | |
outcome required | string Enum: "reversed" "previously-reversed" "decline" "reverse-error" "not-found" … 2 more Standard required response codes.
|
{- "order": {
- "order_id": "3235354"
}, - "outcome": "reversed"
}
{- "error": {
- "code": "validation",
- "message": "Validation error",
- "constraints": {
- "field": [
- {
- "code": "not_null",
- "message": "not_null"
}
]
}
}
}
This request allows users to securely and efficiently access detailed information about a specific alert within the Chargebackhit.
The main purpose of a request in the Chargebackhit is to retrieve detailed information about a specific alert using its unique identifier (UUID). This request allows users to access and review the alert's data, including the alert's details, associated transaction data, and merchant information.
id required | string <uuid> The identifier. |
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object The set of parameters used for detailed information about a specific alert. |
{- "data": {
- "alert": {
- "id": "pal-1ed9d459-3f17-4a10-be7d-a09360154a29",
- "date": "2023-02-20T14:15:22Z",
- "provider": "verifi",
- "product": "oi",
- "type": "inquiry",
- "outcome": "acknowledged",
- "card_acceptor_id": "000000000554111",
- "acquirer_bin": "444111",
- "amount": "10.00",
- "currency": "USD",
- "reason_group": "fraud",
- "rdr": {
- "status": "declined",
- "rule": "This rule will accept all RDR cases above 0.01"
}
}, - "transaction": {
- "transaction_merchant_id": "f150ed65-e5fd-4309-a612-a5f4f84f6071",
- "transaction_id": "633042476707421",
- "date": "2023-01-01T14:15:22Z",
- "amount": "10.00",
- "currency": "USD",
- "type": "sale",
- "card_brand": "VISA",
- "bin": "411111",
- "last_four": "1111",
- "auth_code": "00251",
- "arn": "24871153022084127852235"
}, - "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}
}
}
This request allows users to securely and effectively retrieve a tailored list of alerts from the Chargebackhit based on a wide range of filtering parameters, ensuring the retrieval of relevant information.
The main purpose of the request in the Chargebackhit is to retrieve a list of alerts based on various filtering parameters, including alert types, outcomes, providers, products, transaction details, and merchant-related information. This request allows users to narrow down and access specific sets of alerts based on their requirements.
Additionally, the request provides pagination options to limit the number of results, helping manage network traffic and improve efficiency.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object The set of parameters used for detailed filtering. | |
object Pagination to limit the number of results to help keep network traffic in check. | |
object The fields must be indexed to be sorted by them. Thereafter, you can select which parameters to sort by. |
Array of objects The set of parameters used for detailed information about a specific alert. | |
object Pagination to limit the number of results to help keep network traffic in check. |
{- "filter": {
- "ids": [
- "id1",
- "id2"
], - "created_at_from": "2023-01-01T00:00:00Z",
- "created_at_to": "2023-01-31T23:59:59Z",
- "alert_date_from": "2023-01-10T00:00:00Z",
- "alert_date_to": "2023-02-10T23:59:59Z",
- "merchant_ids": [
- "4e3b7f3f-2e1f-4fd3-9d4f-3a8f2e4e576d",
- "8a1b5c7e-7eab-4f2a-92f8-228c7b5e16f4"
], - "merchant_internal_ids": [
- "QWE1234",
- "RTY1234"
], - "types": [
- "inquiry",
- "fraud-notification"
], - "outcomes": [
- "reversed",
- "acknowledged"
], - "providers": [
- "ethoca",
- "verifi"
], - "products": [
- "oi",
- "cdrn"
], - "transaction_date_from": "2023-01-01T00:00:00Z",
- "transaction_date_to": "2023-01-31T23:59:59Z",
- "arns": [
- "74624453223331975021538",
- "24005453223520000007553"
], - "auth_codes": [
- "00251",
- "00452"
], - "transaction_merchant_ids": [
- "f150ed65-e5fd-4309-a612-a5f4f84f6071",
- "4a2ed65-l3cd-9302-b612-a5f4f84f6072"
], - "amount_usd_from": "5.00",
- "amount_usd_to": "100.00",
- "currencies": [
- "USD",
- "EUR"
], - "bin": "422121",
- "last_four": "1111",
- "order_ids": [
- "b7ffcd9b-1ff5-48cd-94de-5c832547a9de",
- "29c6530f-81aa-4964-9969-794f9fc143ac"
], - "transaction_ids": [
- "633042476707421",
- "633042476707422"
], - "transaction_types": [
- "sale"
], - "descriptors": [
- "Online Tech Store",
- "Gadget World"
], - "caids": [
- "000000000309705",
- "000000000209707"
], - "acquirer_bins": [
- "444111",
- "555222"
], - "acquirer_names": [
- "Acquirer A",
- "Acquirer B"
]
}, - "pagination": {
- "limit": 100,
- "offset": 0
}, - "sort": {
- "field": "created_at",
- "direction": "asc"
}
}
{- "data": [
- {
- "alert": {
- "id": "pal-1ed9d459-3f17-4a10-be7d-a09360154a29",
- "date": "2023-02-20T14:15:22Z",
- "provider": "verifi",
- "product": "oi",
- "type": "inquiry",
- "outcome": "acknowledged",
- "card_acceptor_id": "000000000554111",
- "acquirer_bin": "444111",
- "amount": "10.00",
- "currency": "USD",
- "reason_group": "fraud",
- "rdr": {
- "status": "declined",
- "rule": "This rule will accept all RDR cases above 0.01"
}
}, - "transaction": {
- "transaction_merchant_id": "f150ed65-e5fd-4309-a612-a5f4f84f6071",
- "transaction_id": "633042476707421",
- "date": "2023-01-01T14:15:22Z",
- "amount": "10.00",
- "currency": "USD",
- "type": "sale",
- "card_brand": "VISA",
- "bin": "411111",
- "last_four": "1111",
- "auth_code": "00251",
- "arn": "24871153022084127852235"
}, - "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}
}
], - "pagination": {
- "offset": 100,
- "limit": 100,
- "total_count": 999
}
}
Webhooks are a simple yet powerful way to receive automated notifications from Chargebackhit.
With Webhooks, you can set up your application to receive notifications whenever certain alert events occur and make instant action and applicable responses.
In the Chargebackhit webhooks implementation, there are several types of webhooks based on the alert type parameter.
Prevent webhooks are triggered when a transaction inquiry occurs that requires an immediate response - sharing transaction details, including order, customer, and product. Prevent represents the inquiry
and prevented
webhook alert types. Prevent includes Order Insight (OI), Compelling Evidence (CE3.0), and Consumer Clarity (CC).
All transaction data can affect and increase a cardholder and issuer experience. The more valid and relevant data provided, the more effective the response can be. In addition to the basic value of Prevent, the Compelling Evidence 3.0 rule aims to deflect fraud disputes when specific conditions are met and valid mandatory fields are transferred. The mandatory fields are highlighted with the CE3.0
badges.
Resolve webhooks are triggered when a merchant-directed refund is needed to resolve a potential dispute case or automated pre-dispute resolution has occurred. Merchant-directed refunds are notified by the alert type init-refund
(CDRN, ETHOCA), while automated pre-dispute resolutions are notified by the alert type resolved
(RDR).
Inform webhooks are triggered when a Visa Fraud or Dispute case is filed with alert types fraud-notification
or dispute-notification
, respectively.
Prevent, Resolve, and Inform webhooks have a unified structure and need to be distinguished by the alert type, with specific products and providers specified in the corresponding fields.
The responses should be in accordance with the specified alert type.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object All information about the alert. | |
object Associated with the alert transaction data. Used for matching alert to transaction. | |
object Information about the MID. |
outcome required | string Default: "acknowledged" Standard required response codes. |
object It contains all the information available for the order. | |
required | object The customer information parameters are a set of user identifiers you share alongside your order information. |
Array of objects It contains all the information available for the related transactions. | |
required | Array of objects Additional information of the products that was purchased. |
object
Information about the merchant, including their contacts, policies, and more, can be provided as a default during MID enrollment. If such parameters are not transmitted by the merchant, Chargebackhit will send them by default using the information provided during the onboarding process. |
{- "alert": {
- "id": "pal-1ed9d459-3f17-4a10-be7d-a09360154a29",
- "date": "2023-02-20T14:15:22Z",
- "provider": "verifi",
- "product": "oi",
- "type": "inquiry",
- "outcome": "acknowledged",
- "card_acceptor_id": "000000000554111",
- "acquirer_bin": "444111",
- "amount": "10.00",
- "currency": "USD",
- "reason_group": "fraud",
- "rdr": {
- "status": "declined",
- "rule": "This rule will accept all RDR cases above 0.01"
}
}, - "transaction": {
- "transaction_merchant_id": "f150ed65-e5fd-4309-a612-a5f4f84f6071",
- "transaction_id": "633042476707421",
- "date": "2023-01-01T14:15:22Z",
- "amount": "10.00",
- "currency": "USD",
- "type": "sale",
- "card_brand": "VISA",
- "bin": "411111",
- "last_four": "1111",
- "auth_code": "00251",
- "arn": "24871153022084127852235"
}, - "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}
}
{- "outcome": "acknowledged",
- "order": {
- "order_id": "3235354",
- "date": "2014-11-01T14:15:22Z",
- "amount": "19.99",
- "currency": "USD",
- "address": {
- "address1": "94 Mayflower Street Bronx",
- "address2": "Apt 2B",
- "city": "New York",
- "postal_code": "10001",
- "region": "NY",
- "country": "USA"
}, - "refund": {
- "amount": "19.99",
- "currency": "USD",
- "date": "2014-11-01T14:15:22Z"
}
}, - "customer": {
- "first_name": "John",
- "last_name": "Doe",
- "date_of_birth": "1985-11-01T00:00:00Z",
- "customer_id": "JD123458932",
- "first_transaction_date": "2014-11-01T14:15:22Z",
- "length_of_relationship": "5 years",
- "authentication_used": "username",
- "phone": "+1234567890",
- "email": "jonh@mail.com",
- "device": {
- "name": "Johns Phone",
- "identifier": "12313212-asdfa-123123",
- "location": "New York",
- "ip_address": "192.168.50.123",
- "type": "PC",
- "fingerprint": "f82c23f0-74ef-11eb-9439-0242ac130002"
}
}, - "transactions": [
- {
- "date": "2014-11-01T14:15:22Z",
- "currency": "USD",
- "amount": "22.24",
- "bin": "123456",
- "last_four": "1114",
- "transaction_merchant_id": "3235312",
- "transaction_id": "201409338",
- "type": "sale",
- "recurring_transaction": "monthly"
}
], - "products": [
- {
- "name": "Z 12 Month Antivirus Protection 1",
- "sku": null,
- "description": "12 month premium antivirus for Windows",
- "quantity": "1; 2 pieces; 3 kg; ...",
- "notes": "Includes free monthly security updates"
}
], - "merchant": {
- "merchant_name": "Acme Corporation",
- "merchant_contact_phone": "+123456789012",
- "merchant_address": {
- "address1": "94 Mayflower Street Bronx",
- "address2": "Apt 2B",
- "city": "New York",
- "postal_code": "10001",
- "region": "NY",
- "country": "USA"
}, - "store_name": "Acme Online Store",
}
}
The API offers comprehensive tools for managing and analyzing merchant and CAID data, enabling businesses to assess risk levels, and create holistic risk profiles.
The request enables users to retrieve specific merchant details using a unique identifier id
. The response includes the merchant's id
, name
, and payment descriptor
.
id required | string <uuid> The identifier. |
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object Information about the MID. |
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}
}
The request provides list of retrieves merchant lists using flexible filtering, sorting, and pagination options. Users can paginate results, sort by specified fields, and filter by parameters like ids
, descriptors
, and names
. The response contains merchant details and pagination information.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object Pagination to limit the number of results to help keep network traffic in check. | |
object The fields must be indexed to be sorted by them. Thereafter, you can select which parameters to sort by. | |
object The set of parameters used for detailed filtering. |
Array of objects Information about the MID. | |
object Pagination to limit the number of results to help keep network traffic in check. |
{- "pagination": {
- "limit": 100,
- "offset": 0
}, - "sort": {
- "field": "name",
- "direction": "asc"
}, - "filter": {
- "ids": [
- "123e4567-e89b-12d3-a456-426614174000",
- "123e4567-e89b-12d3-a456-426614174001"
], - "descriptors": [
- "Online Tech Store",
- "Gadget World"
], - "internal_ids": [
- "QWE1234",
- "RTY1234"
], - "name": "Amazing Electronics"
}
}
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}
], - "pagination": {
- "offset": 100,
- "limit": 100,
- "total_count": 999
}
}
The method to retrieve individual CAID (Card Acceptor ID) details using a unique identifier id
.
id required | string <uuid> The identifier. |
include | Array of arrays Items Value: "caid.activities" Include the payment this chargeback was issued for. |
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object The set of parameters used for retrieving individual CAID details. |
{- "data": {
- "id": "a1b2c3d4-e5f6-4789-abcd-1234567890ef",
- "psp_name": "Stripe",
- "bin": "411111",
- "caid": "123456789012",
- "active_from": "2022-10-01T00:00:00Z",
- "created_at": "2022-10-01T14:30:00Z",
- "mcc": "5812",
- "description": "QWE12345",
- "status": "active",
- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}, - "activities": [
- {
- "provider": "cdrn",
- "product": "verifi",
- "alert_type": "init-refund",
- "active_from": "2022-08-31T09:47:17Z"
}
], - "required_products": [
- "oi"
], - "info": {
- "ethoca_status": "enrolled",
- "ethoca_consumer_clarity_status": "in-process",
- "verifi_rdr_status": "enrolled",
- "verifi_oi_status": "in-process",
- "verifi_fraud_status": "enrolled",
- "verifi_dispute_status": "sent-to-enrollment",
- "verifi_cdrn_status": "enrolled"
}
}
}
Leveraging the API's ability to access a list of CAIDs with comprehensive filtering, sorting, and pagination options, the response can gather crucial information such as PSP identifiers, BINs, and merchant details.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object Pagination to limit the number of results to help keep network traffic in check. | |
object The fields must be indexed to be sorted by them. Thereafter, you can select which parameters to sort by. | |
object The set of parameters used for detailed filtering. |
Array of objects The set of parameters used for retrieving individual CAID details. | |
object Pagination to limit the number of results to help keep network traffic in check. |
{- "pagination": {
- "limit": 100,
- "offset": 0
}, - "sort": {
- "field": "created_at",
- "direction": "asc"
}, - "filter": {
- "ids": [
- "a1b2c3d4-e5f6-4789-abcd-1234567890ef",
- "ad7h8i9j0-e3f6-7489-afcd-stuvwx9y12ef"
], - "psp_names": [
- "Stripe",
- "Adyen"
], - "bins": [
- "411111",
- "411312"
], - "caids": [
- "123456789012",
- "983456787012"
], - "mccs": [
- "5732",
- "6754"
], - "merchant_ids": [
- "m123",
- "n456"
], - "active_from_from": "2022-01-01T00:00:00Z",
- "active_from_to": "2022-12-31T23:59:59Z",
- "created_at_from": "2022-01-01T00:00:00Z",
- "created_at_to": "2022-12-31T23:59:59Z",
- "updated_at_from": "2022-01-01T00:00:00Z",
- "updated_at_to": "2022-12-31T23:59:59Z",
- "descriptions": [
- "QWE1234",
- "RTY1234"
], - "merchant_internal_ids": [
- "QWE1234",
- "RTY1234"
], - "descriptors": [
- "Online Tech Store",
- "Gadget World"
], - "statuses": [
- "active",
- "pending"
]
}
}
{- "data": [
- {
- "id": "a1b2c3d4-e5f6-4789-abcd-1234567890ef",
- "psp_name": "Stripe",
- "bin": "411111",
- "caid": "123456789012",
- "active_from": "2022-10-01T00:00:00Z",
- "created_at": "2022-10-01T14:30:00Z",
- "mcc": "5812",
- "description": "QWE12345",
- "status": "active",
- "merchant": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "[Merchant][Descriptor]",
- "descriptor": "paymentdescriptor.com",
- "internal_id": "QWE12345"
}, - "activities": [
- {
- "provider": "cdrn",
- "product": "verifi",
- "alert_type": "init-refund",
- "active_from": "2022-08-31T09:47:17Z"
}
], - "required_products": [
- "oi"
], - "info": {
- "ethoca_status": "enrolled",
- "ethoca_consumer_clarity_status": "in-process",
- "verifi_rdr_status": "enrolled",
- "verifi_oi_status": "in-process",
- "verifi_fraud_status": "enrolled",
- "verifi_dispute_status": "sent-to-enrollment",
- "verifi_cdrn_status": "enrolled"
}
}
], - "pagination": {
- "offset": 100,
- "limit": 100,
- "total_count": 999
}
}
The method allows enrolling a batch of MIDs, streamlining the process of registering multiple merchants or card acceptor IDs.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
description | string Internal ID or something else that is used to identify the MID. |
descriptor required | string Payment descriptor. |
card_acceptor_id | string Identification value used by card brands and banks to identify the location of the card acceptor terminal. |
acquirer_bin | string This field contains a six-digit Bank Identification Number (BIN) issued by the merchant's bank or processor. |
psp_name required | string PSP identifier for recognition. |
mcc | string Setting merchant category codes. |
required_products | Array of strings This parameter specifies the products that enrolled for this CAID. |
arns | Array of strings [ 3 .. 10 ] items [ items = 23 characters .{1}4.{21} ] The Acquirer Reference Number (ARN) is a unique number assigned to a credit card transaction as it moves through the payment flow. It is crucial for tracking transactions, particularly in cases of disputes, refunds, or chargebacks. |
merchant_internal_id | string Internal ID or something else that is used to identify the MID. |
[- {
- "description": "PQR9876",
- "descriptor": "GadgetEmperia*Purchase",
- "card_acceptor_id": "998877665544",
- "acquirer_bin": "789012",
- "psp_name": "Stripe",
- "mcc": "5732",
- "required_products": [
- "ethoca"
], - "arns": [
- "99887766554433221100998",
- "77665544332211009988777",
- "66554433221100998877666"
], - "merchant_internal_id": "PQR9876"
}
]
{- "error": {
- "code": "validation",
- "message": "Validation error",
- "constraints": {
- "field": [
- {
- "code": "not_null",
- "message": "not_null"
}
]
}
}
}
The request facilitates the retrieval of enrollment lists through flexible filtering, sorting, and pagination options. Users have the ability to paginate results and apply filters based on parameters such as statuses and descriptions.
The response contains `card_id` that associated with entity from `/api/v2/caids/list`.
signature | string <= 500 characters Signature of the request allows verifying whether the request is genuine. |
public_key | string <= 500 characters Unique identification that is shared at the moment of registration along with the Private Key. |
object Pagination to limit the number of results to help keep network traffic in check. | |
object The set of parameters used for detailed filtering. |
Array of objects The set of parameters used for detailed information about enrollment lists. | |
object Pagination to limit the number of results to help keep network traffic in check. |
{- "pagination": {
- "limit": 100,
- "offset": 0
}, - "filter": {
- "merchant_internal_ids": [
- "QWE1234",
- "RTY1234"
], - "descriptions": [
- "QWE1234",
- "RTY1234"
], - "statuses": [
- "new",
- "success"
]
}
}
{- "data": [
- {
- "id": "a1b2c3d4-e5f6-4789-abcd-1234567890ef",
- "description": "QWE1234",
- "descriptor": "HeadphonesStore*Purchase",
- "card_acceptor_id": "123456789012",
- "acquirer_bin": "411111",
- "psp_name": "Stripe",
- "mcc": "5732",
- "caid_id": "4a51f553-6ddd-4098-8550-fe1e9b477693",
- "required_products": [
- "oi"
], - "import_message": "duplicate",
- "status": "new",
- "arns": [
- "7234567890123456",
- "9876543210987654"
], - "merchant_internal_id": "QWE1234"
}
], - "pagination": {
- "offset": 100,
- "limit": 100,
- "total_count": 999
}
}
The changelog is crucial for documenting all modifications, enhancements, and removals to the API. It is essential for developers and users to track changes, understand new features, and adjust their implementations.
Equally important is staying informed about updates in the broader Business Guide changelog, which provides comprehensive details on product-level changes specific to chargeback prevention.
28 February 2024
Removed a deprecated billing_address
field from the webhook inquiry response
14 February 2024
Added an outcome
field to indicate the outcome of an alert in the responses for the get alert and get alert list endpoints
08 February 2024
Added an info
object to indicate the enrollment status of a MID in the responses for the get caid and get caid list endpoints
31 January 2024
Added:
required_products
updated_at_from
and updated_at_to
parameters for the get caid list request