Webhook Notification

post

https://your-url-endpoint.com/api/v1/webhook

The webhook notification serves to provide a notification that informs the Remote Host about actions that have been made or information that needs to be relayed to your own customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

event_type

string

enum

required

card_opaque_id

string

Only available in reconciliation success webhook

attempted_spend

string

currency

string

customer_opaque_id

string

method

string

destination

string

type

string

otp

string

limit_type

string

limit_amount

string

current_spend

string

only available in event type just_in_time_funding_recommendation. Indicate the current amount spend of a merchant in one day

transaction_id

string

only available in event_type=transaction

transaction_amount

string

in `event_2

transaction_date

string

only available in event_type=transaction

transaction_type

string

enum

only available in event_type=transaction and reconciliation_manual_adjustment

Available values in event_type=transaction are:
oct - original credit transaction
balance_inquiry - happens when card is used at an ATM
deduction - authorization where a deduction is requested
hold - pre authorization request
debit_verify - when the acquiring merchant attempts to validate card before online transactions
completion - pre authorization completion
partial_reversal - partial reversal
reversal - when a transaction is reversed before being cleared

Available values in reconciliation_manual_adjustment are:
ADDITION - original credit transaction
DEDUCTION - authorization where a deduction is requested
REFUND - offline refund
For more explanation, please check transaction type

transaction_status

string

enum

Valid values:
approved
rejected

Allowed:

merchant_name

string

name of the merchant for the specific transaction

authorization_code

string

An authorization code is a six-digit number that is used to confirm that a payment card transaction is approved.

transactions

object

only available in event type reconciliation success
For more explanation on amount and currency, please check here

recommended_action

object

only available when event type is reconciliation_manual_adjustment

auth_code

string

amount

string

acquirer_amount

string

only available in event_type=transaction. Acquirer Amount

acquirer_currency

string

only available in event_type=transaction. Acquirer Currency

terminal_id

string

idempotency_key

string

key used to keep the request idempotent

visa_transaction_id

string

same as the transaction sent in authorization phase

retrieval_reference_number

string

only available in event_type=transaction, ISO8583 Field 37

merchant_location

string

only available in event_type=transaction, location of the merchant for the specific transaction

masked_card_number

string

only available in event type otp_notification (notes: in staging only)

cards

object

only available in event typecard_delivery

contract_opaque_id

string

device_id

string

Only available in event_type card_token_provisioned.

authentication_id

string

merchant_category_code

string

only available in event typereconciliation_manual_adjustment

rejection_reason

string

only available in event_type=transaction and transaction_status is rejected

token_opaque_id

string

card token opaque id, only available in event type card_token_passcode

token_type

string

only available in event type card_token_passcode value is one of HCE SECURE_ELEMENT

token_requestor

string

only available in event type card_token_passcode. Well know token requestor data can be found the possibles values can be found here

cbs_transaction_id

string

only available in event_type=transaction, this correspond to transaction cbs identifier. referred as cbs_transaction_id or cbs_reference_id

last_four_digits

string

only available in event type card_token_provisioned

reason

string

only available in event type reconciliation_manual_adjustment. Valid values:
FX_RATES_ADJUSTMENT: adjustment because of fx rates
BASE_1_ADJUSTMENT: base 1 adjustment (data doesn't present on base 2 clearing file)
BASE_2_ADJUSTMENT: base 2 adjustment (data on base 2 clearing file have different amount compared to base 1)

central_processing_date

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
The date that clearing processed this transaction.
The field contains the date format YDDD (year and day)

conversion_date

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
The date of that was used to convert the currency
The field contains the date format YDDD (year and day)

conversion_rate

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
Omit empty field, only available for USD account currency cards.
The rate that was used to convert to the account amount

rate_table_id

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
Omit empty field, only available for international transactions.
The rate table ID of the foreign exchange rate table used for currency conversion

pos_entry_mode

string

POS entry mode data, the possibles values can be found here

processing_date

string

Only available in event_type settlement_summary. This field indicates the date that the settlement was processed.

token_requestor_id

string

token requestor data for card token transaction. Well know token requestor data can be found the possibles values can be found here

recommended_top_up

string

only available in event type just_in_time_funding_recommendation. Indicate recommended top up amount to cover next day settlement for merchant

source_type

string

enum

only available in event_type settlement_account_topup, source of topup

Allowed:

updated_spendable_balance

string

only available in event_type settlement_account_topup, updated spendable balance after topup

settlement_amount

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
Omit empty field.
The settlement amount based on the settlement currency.

settlement_currency

string

enum

only available in event type settlement_summary and settlement_offset. Settlement Currency

Allowed:

report_date

string

only available in event type settlement_summary and settlement_offset. Settlement Report Date

settlement_type

string

enum

only available in event type settlement_summary and settlement_offset. Settlement Type

Allowed:

settlement_purpose

string

enum

only available in event type settlement_summary and settlement_offset. Settlement Purpose

Allowed:

net_settlement

object

only available in event type settlement_summary and settlement_offset. Net Settlement Amount Info

visa_charges

object

only available in event type settlement_summary and settlement_offset. Visa Charges Info

reimbursement_fee

object

only available in event type settlement_summary and settlement_offset. Reimbursement Fee Info

interchange_fee_amount

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
Interchange fee

interchange_fee_currency

string

only available in event type reconciliation_success and reconciliation_manual_adjustment
Interchange Currency

interchange_fee_type

string

enum

only available in event type reconciliation_success and reconciliation_manual_adjustment
Interchange Fee Type

Allowed:

failed_provision_reason

string

enum

Only available in card_token_provisioning_failed

Allowed:

previous_status

string

enum

Only available in card_token_status_changed
ACTIVE: The token is currently active and can be used for transactions.
SUSPENDED: The token has been temporarily suspended (for example, due to suspected fraud or user request) and cannot be used until reactivated.
DEACTIVATED: The token has been permanently unlinked from the card or device and cannot be reactivated. The token has been permanently unlinked from the card or device and cannot be reactivated. However, if the same card is bound again to the same device, a new token may be issued and become active.

Allowed:

current_status

string

enum

Allowed:

offset_type

string

enum

Only available in event type settlement_offset. The classification of the offset operation.

Allowed:

offset_amount

string

Only available in event type settlement_offset. The monetary value applied during this offset event. This is a signed value (e.g., positive for credits, negative for debits).

remaining_deduction

string

Only available in event type settlement_offset. The outstanding deduction amount remaining for the settlement record after this offset has been applied.

total_atm_decline

string

Only available in event_typesettlement_summary.

acquirer_reference_number

string

Only available in event type reconciliation_success and reconciliation_manual_adjustment. A 23-digit acquirer reference number string.

event_timestamp

string

ISO 8601 UTC timestamp string. Only available in event_type card_pin_set, card_pin_changed, and card_pin_reset.

Headers

X-COP-Signature-256

string

required

Prefixed hashed request body: sha256={hash of the request body with secret}

Responses

200200

400400