Subscribe to webhooks
Understand how to configure your system to receive the necessary real-time event notifications for all transaction status updates.
API Workflow
1
Retrieve the list of available webhooks for subscription
Each specific webhook is called an EVENT, and each event can be identified using its event ID and code.
Webhook events are grouped into use case CATEGORIES, and a webhook category can be identified using its category ID.
Partners can subscribe to a particular event or do a group subscription using categories.
Call List Available Webhook Categories (GET /v1/oauth/consumer/{{consumer_key}}/event/categories) to retrieve all the webhooks available for the program.
Where {{consumer_key}} is the API credential username provided for the program.
List Available Webhook Categories request
CURL
curl --location 'https://{{platform_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/event/categories' \
--header 'Authorization: ••••••'List Available Webhook Categories response
JSON
[
{
"id": "62a827dc956b0cf18d04f9fa01346f0e",
"name": "Pre Auth",
"events": [
{
"id": "3cfb7df8871badb099f1926d703aefc8",
"name": "Pre auth transaction",
"code": "OPENLOOP_PRE_AUTH"
}
]
},
{
"id": "4a31898cbe8f7e2d386b3181cf5a2f60",
"name": "Succesful Transaction Notifications",
"events": [
{
"id": "b70f5601f8f6a4e96022456f7c1f4893",
"name": "Post auth transaction",
"code": "OPENLOOP_POST_AUTH"
},
{
"id": "6ca22fdb0a3f5f067d4d2823f7098feb",
"name": "Account verification",
"code": "OPEN_LOOP_ACCOUNT_VERIFICATION"
}
]
},
{
"id": "3b00b6957aa14d43a44dd1f37bd21357",
"name": "Decline Transaction Notifications",
"events": [
{
"id": "88a2bd58d9b53a77c5056e6f1d3dad55",
"name": "Invalid transaction",
"code": "OPENLOOP_DECLINED_INVALID_TRANSACTION"
},
{
"id": "aab307782f877d59fd1c0bf4778ddaef",
"name": "Insufficient prefund balance",
"code": "OPENLOOP_DECLINED_INSUFFICIENT_CONSUMER_BALANCE"
},
{
"id": "70bc46a648164b6a35903c735d28b17b",
"name": "Invalid user balance",
"code": "OPENLOOP_DECLINED_INSUFFICIENT_BALANCE"
},
{
"id": "1c50750165f454b16982340e797826e4",
"name": "Insufficient category balance",
"code": "OPENLOOP_DECLINED_INSUFFICIENT_CATEGORY_BALANCE"
},
{
"id": "25eee8531e2814374ab2116f391fa3c7",
"name": "Category limit reached",
"code": "OPENLOOP_DECLINED_CATEGORY_LIMIT_REACHED"
},
{
"id": "5b2d7fdd41fdc16f7ed4a11e3ad9d39c",
"name": "User card is blocked",
"code": "OPENLOOP_DECLINED_CARD_BLOCKED"
},
{
"id": "d04492778e878895eb01db600c45a3a7",
"name": "User card is suspended",
"code": "OPENLOOP_DECLINED_CARD_SUSPENDED"
},
{
"id": "7583bbb1cd25a29ec1e850c30b13bb49",
"name": "Invalid transaction type",
"code": "OPENLOOP_DECLINED_INVALID_TRANSACTIONTYPE"
},
{
"id": "befcf0ac3399dba61579a247664907fd",
"name": "Unsupported merchants",
"code": "OPENLOOP_DECLINED_UNSUPPORTED_PROGRAM_MERCHANTS"
},
{
"id": "079f95eedd447911eec531f683fb3245",
"name": "Transaction limit reached",
"code": "OPENLOOP_DECLINED_RISKCHECKFAILED"
},
{
"id": "dd85c117bde9c15a8e1b967a91618a2c",
"name": "Transaction is already authorized",
"code": "OPENLOOP_DECLINED_ALREADY_AUTHORIZED_TRANSACTION"
},
{
"id": "e94b3e30e219be9cc05f4ca9864b1ea1",
"name": "Refernce id not found",
"code": "OPENLOOP_DECLINED_REFRENCE_NOT_FOUND"
},
{
"id": "cba40729dee1cf5c896229c7fb5997a1",
"name": "Aggredated limit reached",
"code": "OPENLOOP_DECLINED_AGGREGATE_LIMIT_REACHED"
},
{
"id": "eab29eeced6e199c09cf2bbccd2ffbeb",
"name": "User is suspended",
"code": "OPENLOOP_DECLINED_USER_SUSPENDED"
},
{
"id": "dec3d2392587f3bf73423d0efee73706",
"name": "User is blocked",
"code": "OPENLOOP_DECLINED_USER_BLOCKED"
},
{
"id": "91f7f0db6b0271689f24b7e717d05b43",
"name": "User card is still on pending activation",
"code": "OPENLOOP_DECLINED_CARD_PENDING_ACTIVATION"
},
{
"id": "c77ad7738e62ff49232dc9ea978cc877",
"name": "User not found",
"code": "OPENLOOP_DECLINED_USER_NOT_FOUND"
},
{
"id": "4ad416f07be17419fe5295c2d770ff1e",
"name": "Acquiring merchant country is not supported",
"code": "OPENLOOP_DECLINED_UNSUPPORTED_ACQUIRING_MERCHANT_COUNTRY"
},
{
"id": "ce15c4bbb10272cbeb838c22baa09f63",
"name": "Transaction currency is not supported",
"code": "OPENLOOP_DECLINED_UNSUPPORTED_TRANSACTION_CURRENCY"
},
{
"id": "df970772d76a0bb45169db435e8b3f1a",
"name": "User Limit Breached",
"code": "OPENLOOP_DECLINED_USERS_LIMITS_BREACHED"
},
{
"id": "32cb266f1bda54262ec870f7c94fd6db",
"name": "Program limit exceeded",
"code": "OPENLOOP_DECLINED_PROGRAM_LIMITS_BREACHED"
},
{
"id": "7d2c3775085121ce40880be6068902e0",
"name": "ATM_DOMESTIC is not enable at program level",
"code": "OPENLOOP_DECLINED_PROGRAM_ATM_DOMESTIC_LIMITS_BREACHED"
},
{
"id": "f8f78053c68605cf42e9dadb12999d82",
"name": "POS is not enable at program level",
"code": "OPENLOOP_DECLINED_PROGRAM_POS_LIMITS_BREACHED"
},
{
"id": "d2efd1b09dc4d82e5e1096bb69f7c518",
"name": "POS_CONTACTLESS is not enable at user program level",
"code": "OPENLOOP_DECLINED_PROGRAM_POS_CONTACTLESS_LIMITS_BREACHED"
},
{
"id": "9530f023ead486b86252d8ac843da90c",
"name": "ECOM is not enable at program level",
"code": "OPENLOOP_DECLINED_PROGRAM_ECOM_LIMITS_BREACHED"
},
{
"id": "b96800fba1298e79637a8f36ff170634",
"name": "ATM is not enable at program level",
"code": "OPENLOOP_DECLINED_PROGRAM_ATM_LIMITS_BREACHED"
},
{
"id": "7a4474ae3cf9565c24a61ab58ab6b57c",
"name": "ATM is not enable at user level",
"code": "OPENLOOP_DECLINED_USERS_ATM_DOMESTIC_LIMITS_BREACHED"
},
{
"id": "69e39f93cdf663cb97ed5236e944b103",
"name": "POS_CONTACTLESS is not enable at user level",
"code": "OPENLOOP_DECLINED_USERS_POS_CONTACTLESS_LIMITS_BREACHED"
},
{
"id": "590cebdd0b3cb76ae3b20d78e9ff7112",
"name": "POS is not enable at user level",
"code": "OPENLOOP_DECLINED_USERS_POS_LIMITS_BREACHED"
},
{
"id": "20e1d33223932a0525aa87e709e8de1b",
"name": "ECOM is not enable at user level",
"code": "OPENLOOP_DECLINED_USERS_ECOM_LIMITS_BREACHED"
},
{
"id": "7d7b88f293e87f1abdf55359a9874619",
"name": "Preauth decline because of timeout",
"code": "PREAUTH_TIMEOUT_DECLINE"
},
{
"id": "9a2102cab0009bed212deb36e235d478",
"name": "General preauth failure",
"code": "PREAUTH_GENERAL_DECLINE"
},
{
"id": "1a8a8b2d3fbd9a96c40a048675bdc50e",
"name": "User's OFAC check failed",
"code": "OPENLOOP_DECLINED_OFACCHECKFAILED"
}
]
},
{
"id": "bf1d70bc1f5f1ee0de513e503b817879",
"name": "Open Loop Reversals",
"events": [
{
"id": "da4179e8276b7ed169303d5ef0044351",
"name": "Reversal transaction",
"code": "OPENLOOP_TRANSACTION_REVERSAL"
},
{
"id": "538eac15761a3b1b72329cdff0743ccd",
"name": "Reversal category limit reached",
"code": "OPENLOOP_REVERSAL_CATEGORY_LIMIT_REACHED"
},
{
"id": "ada335601419c9670f72d3e59fbeffc0",
"name": "Reversal aggregate limit reached",
"code": "OPENLOOP_REVERSAL_AGGREGATE_LIMIT_REACHED"
}
]
},
{
"id": "f544f5c43a91ee87a1a311555ca95bb1",
"name": "Settlement Advice",
"events": [
{
"id": "5eda0dbfc0701b5fe0189da744fb70de",
"name": "Settlement Batch Success",
"code": "SETTLEMENT_BATCH_SUCCESS"
},
{
"id": "a56963ea6c6627f73e3cee1c566ae4d7",
"name": "Auth Released Batch Success",
"code": "AUTHRELEASE_BATCH_SUCCESS"
},
{
"id": "05c563ca90a1840b935e6327872b8325",
"name": "Credit Voucher Batch Success",
"code": "CREDITVOUCHER_BATCH_SUCCESS"
},
{
"id": "b31da1630d9b24226677dfdde3fef81c",
"name": "Mismatch Batch Success",
"code": "MISMATCH_BATCH_SUCCESS"
},
{
"id": "74cfd20f96e723ba996adaa8edb3690c",
"name": "No Auth Batch Success",
"code": "NOAUTH_BATCH_SUCCESS"
}
]
},
{
"id": "b76f265693a47ba3dac4603223856d4d",
"name": "KYC Service Advisory",
"events": [
{
"id": "d933faeec8e6fd0c754f8ac5f80a8c38",
"name": "KYC Initiate Verification Started",
"code": "ACCOUNT.KYC.VERIFICATION_START"
},
{
"id": "1f51bf72d0322bf07be422e072b43a66",
"name": "KYC Verification Completed",
"code": "ACCOUNT.KYC.VERIFICATION_COMPLETED"
},
{
"id": "671b8658f5506da39635a276627dad7e",
"name": "KYC Verification Failed",
"code": "ACCOUNT.KYC.VERIFICATION_FAILED"
},
{
"id": "04bf7161fd543994d9b8e52ecfa78f80",
"name": "KYC Verification Approved",
"code": "ACCOUNT.KYC.VERIFICATION_APPROVED"
},
{
"id": "d0f3a8ce573691085fec0ba81ca49196",
"name": "KYC Verification Rejected",
"code": "ACCOUNT.KYC.VERIFICATION_REJECTED"
},
{
"id": "8cd383f74bdf4d3f9a53d2e17d3ad98c",
"name": "KYC Document Verification Update",
"code": "USER.DOCUMENT_VERIFICATION.STATUS"
}
]
},
{
"id": "e3f8cd88cabd276054203c7349df8b58",
"name": "Virtual Accounts Advisory",
"events": [
{
"id": "443013887ac43a2e184fd7b6419d9622",
"name": "Bank Transfer Credit Success",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_CREDIT.SUCCESS"
},
{
"id": "73fb2d5f2964edad1682e7d6cfbad5f8",
"name": "Bank Transfer Credit Failed",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_CREDIT.FAILED"
},
{
"id": "f7a772c85cabfb6f5791f00806c49ac2",
"name": "Bank Transfer Debit Success",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_DEBIT.SUCCESS"
},
{
"id": "17154d4e3bd6baa1e247ac982457a296",
"name": "Bank Transfer Debit Failed",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_DEBIT.FAILED"
},
{
"id": "577c17e8892403dbad9f323cf3b71aac",
"name": "Corporate Bank Transfer Credit Success",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_CREDIT.SUCCESS"
},
{
"id": "fc476fe75f7a54c49b0a933ca39a0b04",
"name": "Corporate Bank Transfer Credit Failed",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_CREDIT.FAILED"
},
{
"id": "3f3cb479c0b0271fbaf08ffcaca26b31",
"name": "Bank Transfer Debit Reversal Success",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_DEBIT_REVERSAL.SUCCESS"
},
{
"id": "7fb6d7c6b616a4a5e89af997137728b3",
"name": "Bank Transfer Debit Reversal Failed",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_DEBIT_REVERSAL.FAILED"
},
{
"id": "b4be316271f22c8a666c206a9b85cc81",
"name": "Bank Transfer Credit Reversal Success",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_CREDIT_REVERSAL.SUCCESS"
},
{
"id": "ca483404b7a142b1adeca52b22430a60",
"name": "Bank Transfer Credit Reversal Failed",
"code": "CONSUMER_ACCOUNT.BANK_TRANSFER_CREDIT_REVERSAL.FAILED"
},
{
"id": "8eb34e1cf1574d949a12e86774fb5d76",
"name": "Bank Transfer Corporate Credit Reversal Success",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_CREDIT_REVERSAL.SUCCESS"
},
{
"id": "47e34a62af98dc84f0501aced94479f9",
"name": "Bank Transfer Corporate Credit Reversal Failed",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_CREDIT_REVERSAL.FAILED"
},
{
"id": "62bb5a6908625877dc98e26a847355b5",
"name": "Corporate Bank Transfer Debit Success",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_DEBIT.SUCCESS"
},
{
"id": "85516664270973bbfc3ca6d37378f332",
"name": "Corporate Bank Transfer Debit Failed",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_DEBIT.FAILED"
},
{
"id": "06adf7ec5332ddb04074ac71f7b22ba2",
"name": "Corporate Bank Transfer Debit Reversal Success",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_DEBIT_REVERSAL.SUCCESS"
},
{
"id": "186659a848fc40f056497767910c4463",
"name": "Corporate Bank Transfer Debit Reversal Failed",
"code": "CORPORATE_ACCOUNT.BANK_TRANSFER_DEBIT_REVERSAL.FAILED"
},
{
"id": "1c35b5962b16908bb8776c5ec9f138d4",
"name": "Corporate VA Creation",
"code": "BUSINESS_ACCOUNT.VIRTUAL_ACCOUNT.STATUS"
},
{
"id": "7ccb304aeb974eed7783447da984a377",
"name": "Consumer VA Creation",
"code": "INDIVIDUAL_ACCOUNT.VIRTUAL_ACCOUNT.STATUS"
},
{
"id": "eb1079435e306066542aa17e6089d391",
"name": "Prefund VA Creation",
"code": "PREFUND_ACCOUNT.VIRTUAL_ACCOUNT.STATUS"
},
{
"id": "443013887ac43a2e184fd7b6419d9624",
"name": "Business Bank Transfer Credit Success",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_CREDIT.SUCCESS"
},
{
"id": "73fb2d5f2964edad1682e7d6cfbad5f9",
"name": "Business Bank Transfer Credit Failed",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_CREDIT.FAILED"
},
{
"id": "deefde3e607a11ef8c230281e1d7a895",
"name": "Business Bank Transfer Debit Success",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_DEBIT.SUCCESS"
},
{
"id": "e7a0412e607a11ef8c230281e1d7a895",
"name": "Business Bank Transfer Debit Failed",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_DEBIT.FAILED"
},
{
"id": "f347d1ed607a11ef8c230281e1d7a895",
"name": "Business Bank Transfer Debit Reversal Success",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_DEBIT_REVERSAL.SUCCESS"
},
{
"id": "fb04142d607a11ef8c230281e1d7a895",
"name": "Business Bank Transfer Debit Reversal Failed",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_DEBIT_REVERSAL.FAILED"
},
{
"id": "01e879dd607b11ef8c230281e1d7a895",
"name": "Business Bank Transfer Credit Reversal Success",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_CREDIT_REVERSAL.SUCCESS"
},
{
"id": "0b2b57ae607b11ef8c230281e1d7a895",
"name": "Business Bank Transfer Credit Reversal Failed",
"code": "BUSINESS_ACCOUNT.BANK_TRANSFER_CREDIT_REVERSAL.FAILED"
}
]
},
{
"id": "e3f8cd88cabd276054203c7349df8b69",
"name": "OFAC Service Advisory",
"events": [
{
"id": "e1f3a8ce573691085fec0ba81ca49169",
"name": "OFAC Verification Rejected",
"code": "ACCOUNT.OFAC.VERIFICATION_REJECTED"
},
{
"id": "f2f3a8ce573691085fec1ca81ca50169",
"name": "OFAC Verification Approved",
"code": "ACCOUNT.OFAC.VERIFICATION_CLEARED"
}
]
},
{
"id": "dc7edc47e618cad1c473d026590bb925",
"name": "Payment Acceptance Advisory",
"events": [
{
"id": "a905c3171499e8769fc29bf4cf39d12b",
"name": "Payment Acceptance Failed",
"code": "PAYGW_TRANSACTION_FAILED"
},
{
"id": "336db362040122242a7d33efc5875d40",
"name": "Payment Acceptance Success",
"code": "PAYGW_TRANSACTION_SUCCESS"
}
]
},
{
"id": "24fa3364c14328ec330990fc1190d11e",
"name": "Transaction Payouts Advisory",
"events": [
{
"id": "e238f9dc7ffe310e398190ea9638e852",
"name": "Payout Quote Crossborder Status",
"code": "PAYOUT.QUOTE.CROSSBORDER.STATUS"
},
{
"id": "7d2034d248f040dc9304cfa63fabcd9d",
"name": "Payoute Recipient Crossborder Status",
"code": "PAYOUT.RECIPIENT.CROSSBORDER.STATUS"
},
{
"id": "f1f172d5bfa674690bd09e0220b1194b",
"name": "Payout Transaction Crossborder Status",
"code": "PAYOUT.TRANSACTION.CROSSBORDER.STATUS"
},
{
"id": "31244512cf5054d6cc0d449860c0d90e",
"name": "Payout Transaction Crossborder Review Status",
"code": "PAYOUT.TRANSACTION.CROSSBORDER.REVIEW.STATUS"
},
{
"id": "b08c52f818b6780844edfe5ba2d8e287",
"name": "Accounts Payout Crossborder Transaction Status",
"code": "ACCOUNTS.PAYOUT.CROSSBORDER.TRANSACTION.STATUS"
}
]
},
{
"id": "e1t71u4bzzqq9fo7l6nz80yu64k9gkiq",
"name": "Domestic Payouts Beneficiary",
"events": [
{
"id": "2pr5ps2znxeex3cv9ubn5ovr4s8x486e",
"name": "Domestic Payouts Beneficiary",
"code": "PAYOUT.RECIPIENT.DOMESTIC.STATUS"
}
]
},
{
"id": "e1t71u4bzzqq9fo7l6nz80yu64k9gkij",
"name": "Card Transactions - Non Financial",
"events": [
{
"id": "11a32152b03a749d6bfcc5865300518e",
"name": "CARDS.ACCOUNT_VERIFICATION.STATUS",
"code": "CARDS.ACCOUNT_VERIFICATION.STATUS"
},
{
"id": "480eb54452f63abfa7f2eb0ffb1c62fe",
"name": "CARDS.ACCOUNT_VERIFICATION.AUTHORIZATION",
"code": "CARDS.ACCOUNT_VERIFICATION.AUTHORIZATION"
}
]
},
{
"id": "ff5810f459364c82b845ddc0e6d748f2",
"name": "User Details",
"events": [
{
"id": "f7fa32d64fc1450283b99d68fcd0f4f6",
"name": "Individual user information update",
"code": "USER.INDIVIDUAL.INFORMATION_UPDATE.STATUS"
}
]
},
{
"id": "695824e1003f7a4bd56aa01e878e6ee9",
"name": "Cardholder Authentication",
"events": [
{
"id": "09725074ac90314f0f2985435338ad62",
"name": "CARDS.3DS.AUTHENTICATION",
"code": "CARDS.3DS.AUTHENTICATION"
}
]
}
]List Available Webhook Categories response (except)
{..
- "id": "62a827dc956b0cf18d04f9fa01346f0e", ← Webhook category ID
- "name": "Pre Auth", ← Webhook category name
- "events": [ {"id": "3cfb7df8871badb099f1926d703aefc8", ← Webhook event ID
- "name": "Pre auth transaction", ← Webhook event name
- "code": "OPENLOOP_PRE_AUTH" ← Webhook event code },
..}
2
Subscribe to an entire webhook category
Subscribing to an entire category will redirect all events to a single callback URL. Partners can distinguish which webhook event was fired by the webhook event code.
Call Create Webhook (POST /v1/oauth/consumer/{consumer_key}/webhooks) passing in the callback url and the category_hash.
Create Webhook request
This example is using the webhook category ID of the Pre Auth category (from the List Available Webhook Categories response above).
CURL
curl --location 'https://{{platform_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/webhooks' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: ••••••' \
--data-urlencode 'category_hash=62a827dc956b0cf18d04f9fa01346f0eCreate Webhook response
JSON
{
"id": "2256a9f6635d40e8af2f82abaef47502",
"url": "https://partner.com/webhook/preauth",
"event_hash": "3cfb7df8871badb099f1926d703aefc8",
"event_name": "Pre auth transaction",
"event_code": "OPENLOOP_PRE_AUTH", "status": "Success",
"description": "Subscription processed successfully"}3
Subscribe to an individual event in a webhook category
Partners have the flexibility to subscribe to individual events and set a different callback URL for each of them.
Call Create Webhook (POST /v1/oauth/consumer/{consumer_key}/webhooks) passing in the callback url and the event_hash.
Create Webhook request
This example is using the event ID of the Post Auth Transaction event under the Successful Transaction Notification category (from the List Available Webhook Categories response above).
CURL
curl --location 'https://{{platform_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/webhooks' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: ••••••' \
--data-urlencode 'event_hash=b70f5601f8f6a4e96022456f7c1f4893Create Webhook response
JSON
{
"id": "2256a9f6635d40e8af2f82abaef47502",
"url": "https://partner.com/webhook/postauth",
"event_hash": "b70f5601f8f6a4e96022456f7c1f4893",
"event_name": "Post auth transaction",
"event_code": "OPENLOOP_POST_AUTH", "status": "Success",
"description": "Subscription processed successfully"}4
Retrieve the list of all subscribed webhooks
Call Retrieve Webhook List (GET /v1/oauth/consumer/{consumer_key}/webhooks) to retrieve the list of webhooks that your program is currently subscribed to.
Retrieve Webhook List request
CURL
curl --location 'https://{{platform_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/webhooks' \
--header 'Authorization: ••••••'Retrieve Webhook List response
JSON
{
"id": "2256a9f6635d40e8af2f82abaef47502",
"url": "https://partner.com/webhook/preauth",
"event_hash": "3cfb7df8871badb099f1926d703aefc8",
"event_name": "Pre auth transaction",
"event_code": "OPENLOOP_PRE_AUTH" },{ "id": "2256a9f6635d40e8af2f82abaef47502",
"url": "https://partner.com/webhook/postauth",
"event_hash": "b70f5601f8f6a4e96022456f7c1f4893",
"event_name": "Post auth transaction",
"event_code": "OPENLOOP_POST_AUTH"}
}5
Update a webhook subscription
Partners can update the callback URL in a webhook subscription, whether the subscription is for an event or category.
Call Update Webhook Details (PUT /v1/oauth/consumer/{consumer_key}/webhooks/{webhook_id}) passing the webhook ID of the webhook that you want to update.
Update Webhook Details request
CURL
curl --location —-request PUT 'https://{{platform_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/webhooks/{{webhook_id}}' \
--header 'Authorization: ••••••' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'url=http://www.partner.com/new/preauth'Update Webhook Details response
JSON
{ "id": "2256a9f6635d40e8af2f82abaef47502",
"url": "https://www.partner.com/new/postauth",
"event_hash": "b70f5601f8f6a4e96022456f7c1f4893",
"event_name": "Post auth transaction",
"event_code": "OPENLOOP_POST_AUTH", "status": "Success",
"description": "Subscription updated successfully"}
6
Unsubscribe from a webhook subscription
Partners can delete an existing webhook subscription and stop the defined callback URL from receiving the specific webhook payload.
Call Delete Webhook (DELETE /v1/oauth/consumer/{{consumer_key}}/webhooks/{{webhook_id}}) passing the webhook ID of the webhook that you want to unsubscribe from.
Delete Webhook request
CURL
curl --location --request DELETE 'https://{{platform_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/webhooks/{{webhook_id}}' \
--header 'Authorization: ••••••''Delete Webhook response
JSON
{ "id": "2256a9f6635d40e8af2f82abaef47502",
"url": "https://partner.com/webhook/postauth",
"event_hash": "b70f5601f8f6a4e96022456f7c1f4893",
"event_name": "Post auth transaction",
"event_code": "OPENLOOP_POST_AUTH", "status": "Success",
"description": "Subscription deleted successfully"}
Was this section helpful?
On this page
- Subscribe to webhooks