Skip to main content

Documentation

Retrieve Webhook

Retrieve a webhook.

Use List Webhooks to find the IDs of webhooks.

    • webhook

    • ID of the webhook. String starting with wh_.

  • /v1/webhooks/:webhook

  • Retrieve Webhook

  • curl -X get
    https://sandboxapi.rapyd.net/v1/webhooks/wh_e8385a164607ed0867e93f1a786f806b
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9ac12554-10fd-4eee-bb25-25b23b54df65"
        },
        "data": [
            {
                "token": "wh_e8385a164607ed0867e93f1a786f806b",
                "type": "PAYMENT_COMPLETED",
                "data": {
                    "id": "payment_e3ec8300d93fdfa602957b1d29066387",
                    "mid": "",
                    "paid": true,
                    "order": null,
                    "amount": 40.50,
                    "escrow": null,
                    "status": "CLO",
                    "address": null,
                    "dispute": null,
                    "fx_rate": 1,
                    "invoice": "",
                    "outcome": null,
                    "paid_at": 1681345429,
                    "refunds": null,
                    "captured": true,
                    "ewallets": [
                        {
                            "amount": 40.50,
                            "percent": 100,
                            "ewallet_id": "ewallet_e2150f478c15d97b807b9ed179b798a0",
                            "refunded_amount": 0
                        }
                    ],
                    "metadata": {},
                    "refunded": false,
                    "auth_code": null,
                    "flow_type": "",
                    "created_at": 1681345429,
                    "error_code": "",
                    "ewallet_id": "ewallet_e2150f478c15d97b807b9ed179b798a0",
                    "expiration": 1681346026,
                    "fixed_side": "",
                    "is_partial": false,
                    "description": "testing",
                    "next_action": "not_applicable",
                    "country_code": "IT",
                    "failure_code": "",
                    "instructions": [],
                    "payment_fees": null,
                    "redirect_url": "",
                    "visual_codes": {},
                    "cancel_reason": null,
                    "currency_code": "OMR",
                    "group_payment": "",
                    "receipt_email": "",
                    "textual_codes": {},
                    "customer_token": "cus_35c261176fa9b7d7fc5fcd1d02bacbb4",
                    "payment_method": "card_bcc8a94fd0781949f212ceaaea9fd66c",
                    "receipt_number": "",
                    "transaction_id": "",
                    "failure_message": "",
                    "initiation_type": "customer_present",
                    "original_amount": 40.50,
                    "refunded_amount": 0,
                    "error_payment_url": "https://support.rapyd.net/hc/en-us",
                    "payment_method_data": {
                        "id": "card_bcc8a94fd0781949f212ceaaea9fd66c",
                        "name": "Auto Test",
                        "type": "it_visa_card",
                        "image": "",
                        "last4": "1111",
                        "category": "card",
                        "metadata": null,
                        "acs_check": "unchecked",
                        "cvv_check": "unchecked",
                        "bin_details": {
                            "type": "CREDIT",
                            "brand": "VISA",
                            "level": null,
                            "issuer": "JPMORGAN CHASE BANK, N.A.",
                            "country": "US",
                            "bin_number": "411111"
                        },
                        "next_action": "not_applicable",
                        "webhook_url": "",
                        "expiration_year": "24",
                        "expiration_month": "12",
                        "fingerprint_token": "ocfp_11ECFC39332B40F481220EC01B2F2B1B",
                        "supporting_documentation": ""
                    },
                    "payment_method_type": "it_visa_card",
                    "save_payment_method": true,
                    "complete_payment_url": "https://www.rapyd.net",
                    "remitter_information": {},
                    "statement_descriptor": "Rapyd Automation - DO ",
                    "merchant_reference_id": "",
                    "payment_method_options": {},
                    "merchant_requested_amount": null,
                    "merchant_requested_currency": null,
                    "payment_method_type_category": "card"
                },
                "attempts": [
                    {
                        "error": null,
                        "http_status_code": 404,
                        "http_response_body": "<!doctype html>\n<html lang=en>\n<title>404 Not Found</title>\n<h1>Not Found</h1>\n<p>Failing WH for testing Resend WH tasker</p>\n",
                        "http_response_headers": {
                            "date": "Thu, 13 Apr 2023 00:23:50 GMT",
                            "server": "Werkzeug/2.2.3 Python/3.8.16",
                            "connection": "close",
                            "content-type": "text/html; charset=utf-8",
                            "content-length": "126"
                        }
                    },
                    {
                        "error": null,
                        "http_status_code": 404,
                        "http_response_body": "<!doctype html>\n<html lang=en>\n<title>404 Not Found</title>\n<h1>Not Found</h1>\n<p>Failing WH for testing Resend WH tasker</p>\n",
                        "http_response_headers": {
                            "date": "Thu, 13 Apr 2023 00:41:26 GMT",
                            "server": "Werkzeug/2.2.3 Python/3.8.16",
                            "connection": "close",
                            "content-type": "text/html; charset=utf-8",
                            "content-length": "126"
                        }
                    }
                ],
                "status": "ERR",
                "last_attempt_at": 1681346486,
                "created_at": 1681345429,
                "next_attempt_at": 1681346246
            }
        ]
    }