Skip to main content

OutgoingWebhook

merchant_idstringrequired

The merchant id of the merchant

event_idstringrequired

The unique event id for each webhook

event_typeEventType (string)required

Possible values: [payment_succeeded, payment_failed, payment_processing, payment_cancelled, payment_authorized, payment_captured, action_required, refund_succeeded, refund_failed]

content objectrequired
oneOf
typestringrequired

Possible values: [payment_details]

object objectrequired
payment_idstringrequired

Unique identifier for the payment. This ensures idempotency for multiple payments that have been done by a single merchant.

Possible values: >= 30 characters and <= 30 characters

Example: pay_mbabizu24mvu3mela5njyhpit4
merchant_idstringrequired

This is an identifier for the merchant account. This is inferred from the API key provided during the request

Possible values: <= 255 characters

Example: merchant_1668273825
statusIntentStatus (string)required

The status of the current payment that was made

Possible values: [succeeded, failed, cancelled, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable]

Default value: requires_confirmation
amountint64required

The payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,

Example: 6540
connectorstringnullable

The connector used for the payment

Example: stripe
client_secretstringnullable

It's a token used for client side verification.

Example: pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo
createddate-timenullable

Time when the payment was created

Example: 2022-09-10T10:11:12Z
currencyCurrency (string)required

The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL]

customer_idstringnullabledeprecated

The identifier for the customer object. If not provided the customer ID will be autogenerated. This field will be deprecated soon. Please refer to customer.id

Possible values: non-empty and <= 64 characters

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44
customer objectnullable

Details of customer attached to this payment

idstringnullable

The identifier for the customer.

Possible values: non-empty and <= 64 characters

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44
namestringnullable

The customer's name

Possible values: <= 255 characters

Example: John Doe
emailstringnullable

The customer's email address

Possible values: <= 255 characters

Example: johntest@test.com
phonestringnullable

The customer's phone number

Possible values: <= 10 characters

Example: 9123456789
phone_country_codestringnullable

The country code for the customer's phone number

Possible values: <= 2 characters

Example: +1
descriptionstringnullable

A description of the payment

Example: It's my first payment request
refunds object[]nullable

List of refunds that happened on this intent, as same payment intent can have multiple refund requests depending on the nature of order

  • Array [
    • refund_idstringrequired

    Unique Identifier for the refund

    payment_idstringrequired

    The payment id against which refund is initiated

    amountint64required

    The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc

    Possible values: >= 100

    Example: 6540
    currencystringrequired

    The three-letter ISO currency code

    statusRefundStatus (string)required

    The status for refunds

    Possible values: [succeeded, failed, pending, review]

    reasonstringnullable

    An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive

    error_messagestringnullable

    The error message

    error_codestringnullable

    The code for the error

    unified_codestringnullable

    Error code unified across the connectors is received here if there was an error while calling connector

    unified_messagestringnullable

    Error message unified across the connectors is received here if there was an error while calling connector

    created_atdate-timenullable

    The timestamp at which refund is created

    updated_atdate-timenullable

    The timestamp at which refund is updated

    connectorstringrequired

    The connector used for the refund and the corresponding payment

    Example: stripe
    profile_idstringnullable

    The id of business profile for this refund

  • ]
    • disputes object[]nullable

    List of disputes that happened on this intent

  • Array [
    • dispute_idstringrequired

    The identifier for dispute

    dispute_stageDisputeStage (string)required

    Stage of the dispute

    Possible values: [pre_dispute, dispute, pre_arbitration]

    dispute_statusDisputeStatus (string)required

    Status of the dispute

    Possible values: [dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost]

    connector_statusstringrequired

    Status of the dispute sent by connector

    connector_dispute_idstringrequired

    Dispute id sent by connector

    connector_reasonstringnullable

    Reason of dispute sent by connector

    connector_reason_codestringnullable

    Reason code of dispute sent by connector

    challenge_required_bydate-timenullable

    Evidence deadline of dispute sent by connector

    connector_created_atdate-timenullable

    Dispute created time sent by connector

    connector_updated_atdate-timenullable

    Dispute updated time sent by connector

    created_atdate-timerequired

    Time at which dispute is received

  • ]
    • attempts object[]nullable

    List of attempts that happened on this intent

  • Array [
    • attempt_idstringrequired

    Unique identifier for the attempt

    statusAttemptStatus (string)required

    The status of the attempt

    Possible values: [started, authentication_failed, router_declined, authentication_pending, authentication_successful, authorized, authorization_failed, charged, authorizing, cod_initiated, voided, void_initiated, capture_initiated, capture_failed, void_failed, auto_refunded, partial_charged, partial_charged_and_chargeable, unresolved, pending, failure, payment_method_awaited, confirmation_awaited, device_data_collection_pending]

    amountint64required

    The payment attempt amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,

    Example: 6540
    order_tax_amountint64nullable

    The payment attempt tax_amount.

    Example: 6540
    currencyCurrency (string)nullable

    The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL]

    connectorstringnullable

    The connector used for the payment

    error_messagestringnullable

    If there was an error while calling the connector, the error message is received here

    payment_methodPaymentMethod (string)nullable

    Indicates the type of payment method. Eg: 'card', 'wallet', etc.

    Possible values: [card, card_redirect, wallet, bank_redirect, bank_transfer]

    connector_transaction_idstringnullable

    A unique identifier for a payment provided by the connector

    capture_methodCaptureMethod (string)nullable

    Recommend setting 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors

    Possible values: [automatic, manual, manual_multiple, scheduled, sequential_automatic]

    authentication_typeAuthenticationType (string)nullable

    Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set

    Possible values: [three_ds, no_three_ds]

    Default value: three_ds
    created_atdate-timerequired

    Time at which the payment attempt was created

    Example: 2022-09-10T10:11:12Z
    modified_atdate-timerequired

    Time at which the payment attempt was last modified

    Example: 2022-09-10T10:11:12Z
    cancellation_reasonstringnullable

    If the payment was cancelled the reason will be provided here

    error_codestringnullable

    If there was an error while calling the connectors the error code is received here

    payment_tokenstringnullable

    Provide a reference to a stored payment method

    payment_experiencePaymentExperience (string)nullable

    To indicate the type of payment experience that the customer would go through

    Possible values: [redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp]

    payment_method_typePaymentMethodType (string)nullable

    Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

    Possible values: [apple_pay, credit, debit, google_pay, paypal, we_chat_pay, tazapay, philippine_qr, thailand_qr, bca_va, online_banking_philippine, zand_bank_va, card_payment_redirect, we_chat_h5, we_chat_js, we_chat_qr, alipay_pc, alipay_h5, union_pay, inr_payment_redirect]

    reference_idstringnullable

    Reference to the payment at connector side

    Example: 993672945374576J
    unified_codestringnullable

    (This field is not live yet)Error code unified across the connectors is received here if there was an error while calling connector

    unified_messagestringnullable

    (This field is not live yet)Error message unified across the connectors is received here if there was an error while calling connector

    client_sourcestringnullable

    Value passed in X-CLIENT-SOURCE header during payments confirm request by the client

    client_versionstringnullable

    Value passed in X-CLIENT-VERSION header during payments confirm request by the client

  • ]
    • captures object[]nullable

    List of captures done on latest attempt

  • Array [
    • capture_idstringrequired

    Unique identifier for the capture

    statusCaptureStatus (string)required

    Possible values: [started, charged, pending, failed]

    amountint64required

    The capture amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,

    Example: 6540
    currencyCurrency (string)nullable

    The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL]

    connectorstringrequired

    The connector used for the payment

    authorized_attempt_idstringrequired

    Unique identifier for the parent attempt on which this capture is made

    connector_capture_idstringnullable

    A unique identifier for this capture provided by the connector

    capture_sequenceint32required

    Sequence number of this capture, in the series of captures made for the parent attempt

    error_messagestringnullable

    If there was an error while calling the connector the error message is received here

    error_codestringnullable

    If there was an error while calling the connectors the code is received here

    error_reasonstringnullable

    If there was an error while calling the connectors the reason is received here

    reference_idstringnullable

    Reference to the capture at connector side

  • ]
    • capture_ondate-timenullable

    A timestamp (ISO 8601 code) that determines when the payment should be captured. Providing this field will automatically set capture to true

    Example: 2022-09-10T10:11:12Z
    capture_methodCaptureMethod (string)nullable

    Recommend setting 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors

    Possible values: [automatic, manual, manual_multiple, scheduled, sequential_automatic]

    payment_methodPaymentMethod (string)required

    Indicates the type of payment method. Eg: 'card', 'wallet', etc.

    Possible values: [card, card_redirect, wallet, bank_redirect, bank_transfer]

    payment_method_data objectnullable
    oneOf
    card objectrequired
    last4stringnullable
    card_typestringnullable
    card_networkCardNetwork (string)nullable

    Indicates the card network.

    Possible values: [Visa, Mastercard, AmericanExpress, JCB, DinersClub, Discover, CartesBancaires, UnionPay, Interac, RuPay, Maestro]

    card_issuerstringnullable
    card_issuing_countrystringnullable
    card_isinstringnullable
    card_extended_binstringnullable
    card_exp_monthstringnullable
    card_exp_yearstringnullable
    card_holder_namestringnullable
    payment_checksnullable
    authentication_datanullable
    payment_tokenstringnullable

    Provide a reference to a stored payment method

    Example: 187282ab-40ef-47a9-9206-5099ba31e432
    shipping objectnullable
    address objectnullable

    Address details

    citystringnullable

    The address city

    Possible values: <= 50 characters

    Example: New York
    countryCountryAlpha2 (string)nullable

    Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US]

    line1stringnullable

    The first line of the address

    Possible values: <= 200 characters

    Example: 123, King Street
    line2stringnullable

    The second line of the address

    Possible values: <= 50 characters

    Example: Powelson Avenue
    line3stringnullable

    The third line of the address

    Possible values: <= 50 characters

    Example: Bridgewater
    zipstringnullable

    The zip/postal code for the address

    Possible values: <= 50 characters

    Example: 08807
    statestringnullable

    The address state

    Example: New York
    first_namestringnullable

    The first name for the address

    Possible values: <= 255 characters

    Example: John
    last_namestringnullable

    The last name for the address

    Possible values: <= 255 characters

    Example: Doe
    phone objectnullable
    numberstringnullable

    The contact number

    Example: 9123456789
    country_codestringnullable

    The country code attached to the number

    Example: +1
    emailstringnullable
    billing objectnullable
    address objectnullable

    Address details

    citystringnullable

    The address city

    Possible values: <= 50 characters

    Example: New York
    countryCountryAlpha2 (string)nullable

    Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US]

    line1stringnullable

    The first line of the address

    Possible values: <= 200 characters

    Example: 123, King Street
    line2stringnullable

    The second line of the address

    Possible values: <= 50 characters

    Example: Powelson Avenue
    line3stringnullable

    The third line of the address

    Possible values: <= 50 characters

    Example: Bridgewater
    zipstringnullable

    The zip/postal code for the address

    Possible values: <= 50 characters

    Example: 08807
    statestringnullable

    The address state

    Example: New York
    first_namestringnullable

    The first name for the address

    Possible values: <= 255 characters

    Example: John
    last_namestringnullable

    The last name for the address

    Possible values: <= 255 characters

    Example: Doe
    phone objectnullable
    numberstringnullable

    The contact number

    Example: 9123456789
    country_codestringnullable

    The country code attached to the number

    Example: +1
    emailstringnullable
    order_details object[]nullable

    Information about the product , quantity and amount for connectors. (e.g. Klarna)

  • Array [
    • product_namestringrequired

    Name of the product that is being purchased

    Possible values: <= 255 characters

    Example: shirt
    quantityint32required

    The quantity of the product to be purchased

    Possible values: >= 0

    Example: 1
    amountint64required

    the amount per quantity of product

    tax_ratedoublenullable

    tax rate applicable to the product

    total_tax_amountint64nullable

    total tax amount applicable to the product

    requires_shippingbooleannullable
    product_img_linkstringnullable

    The image URL of the product

    product_idstringnullable

    ID of the product that is being purchased

    categorystringnullable

    Category of the product that is being purchased

    sub_categorystringnullable

    Sub category of the product that is being purchased

    brandstringnullable

    Brand of the product that is being purchased

    product_typeProductType (string)nullable

    Possible values: [physical, digital, travel, ride, event, accommodation]

    product_tax_codestringnullable

    The tax code for the product

  • ]
    • emailstringnullabledeprecated

    description: The customer's email address This field will be deprecated soon. Please refer to customer.email object

    Possible values: <= 255 characters

    Example: johntest@test.com
    namestringnullabledeprecated

    description: The customer's name This field will be deprecated soon. Please refer to customer.name object

    Possible values: <= 255 characters

    Example: John Test
    phonestringnullabledeprecated

    The customer's phone number This field will be deprecated soon. Please refer to customer.phone object

    Possible values: <= 255 characters

    Example: 9123456789
    return_urlstringnullable

    The URL to redirect after the completion of the operation

    Example: https://api.doopayment.com
    authentication_typeAuthenticationType (string)nullable

    Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set

    Possible values: [three_ds, no_three_ds]

    Default value: three_ds
    next_action objectnullable
    oneOf
    redirect_to_urlstringrequired
    typestringrequired

    Possible values: [redirect_to_url]

    cancellation_reasonstringnullable

    If the payment was cancelled the reason will be provided here

    error_codestringnullable

    If there was an error while calling the connectors the code is received here

    Example: E0001
    error_messagestringnullable

    If there was an error while calling the connector the error message is received here

    Example: Failed while verifying the card
    unified_codestringnullable

    error code unified across the connectors is received here if there was an error while calling connector

    unified_messagestringnullable

    error message unified across the connectors is received here if there was an error while calling connector

    payment_experiencePaymentExperience (string)nullable

    To indicate the type of payment experience that the customer would go through

    Possible values: [redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp]

    payment_method_typePaymentMethodType (string)nullable

    Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

    Possible values: [apple_pay, credit, debit, google_pay, paypal, we_chat_pay, tazapay, philippine_qr, thailand_qr, bca_va, online_banking_philippine, zand_bank_va, card_payment_redirect, we_chat_h5, we_chat_js, we_chat_qr, alipay_pc, alipay_h5, union_pay, inr_payment_redirect]

    ephemeral_key objectnullable

    ephemeral_key for the customer_id mentioned

    customer_idstringrequired

    customer_id to which this ephemeral key belongs to

    Possible values: non-empty and <= 64 characters

    Example: cus_y3oqhf46pyzuxjbcn2giaqnb44
    created_atint64required

    time at which this ephemeral key was created

    expiresint64required

    time at which this ephemeral key would expire

    secretstringrequired

    ephemeral key

    connector_transaction_idstringnullable

    A unique identifier for a payment provided by the connector

    Example: 993672945374576J
    reference_idstringnullable

    reference(Identifier) to the payment at connector side

    Example: 993672945374576J
    profile_idstringnullable

    The business profile that is associated with this payment

    attempt_countint32required

    Total number of attempts associated with this payment

    authorization_countint32nullable

    Total number of authorizations happened in an incremental_authorization payment

    external_authentication_details objectnullable

    Details of external authentication

    authentication_flowDecoupledAuthenticationType (string)nullable

    Possible values: [challenge, frictionless]

    electronic_commerce_indicatorstringnullable

    Electronic Commerce Indicator (eci)

    statusAuthenticationStatus (string)required

    Possible values: [started, pending, success, failed]

    ds_transaction_idstringnullable

    DS Transaction ID

    versionstringnullable

    Message Version

    error_codestringnullable

    Error Code

    error_messagestringnullable

    Error Message

    external_3ds_authentication_attemptedbooleannullable

    Flag indicating if external 3ds authentication is made or not

    expires_ondate-timenullable

    Date Time for expiry of the payment

    Example: 2022-09-10T10:11:12Z
    payment_method_idstringnullable

    Identifier for Payment Method used for the payment

    payment_method_statusPaymentMethodStatus (string)nullable

    Payment Method Status

    Possible values: [active, inactive, processing, awaiting_data]

    updateddate-timenullable

    Date time at which payment was updated

    Example: 2022-09-10T10:11:12Z
    extended_authorization_appliedbooleannullable

    flag that indicates if extended authorization is applied on this payment or not

    capture_beforedate-timenullable

    date and time after which this payment cannot be captured

    merchant_order_reference_idstringnullable

    Merchant's identifier for the payment/invoice. This will be sent to the connector if the connector provides support to accept multiple reference ids. In case the connector supports only one reference id, Doo Payment's Payment ID will be sent as reference.

    Possible values: <= 255 characters

    Example: Custom_Order_id_123
    order_tax_amountint64nullable

    This Unit struct represents MinorUnit in which core amount works

    card_discoveryCardDiscovery (string)nullable

    Indicates the method by which a card is discovered during a payment

    Possible values: [manual, saved_card, click_to_pay]

    timestampdate-time

    The time at which webhook was sent

    Outgoing Webhook
    {
      "merchant_id": "string",
      "event_id": "string",
      "event_type": "payment_succeeded",
      "content": {
        "type": "payment_details",
        "object": {
          "payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
          "merchant_id": "merchant_1668273825",
          "status": "requires_confirmation",
          "amount": 6540,
          "connector": "stripe",
          "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
          "created": "2022-09-10T10:11:12Z",
          "currency": "AED",
          "customer": {
            "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
            "name": "John Doe",
            "email": "johntest@test.com",
            "phone": "9123456789",
            "phone_country_code": "+1"
          },
          "description": "It's my first payment request",
          "refunds": [
            {
              "refund_id": "string",
              "payment_id": "string",
              "amount": 6540,
              "currency": "string",
              "status": "succeeded",
              "reason": "string",
              "error_message": "string",
              "error_code": "string",
              "unified_code": "string",
              "unified_message": "string",
              "created_at": "2024-07-29T15:51:28.071Z",
              "updated_at": "2024-07-29T15:51:28.071Z",
              "connector": "stripe",
              "profile_id": "string"
            }
          ],
          "disputes": [
            {
              "dispute_id": "string",
              "dispute_stage": "pre_dispute",
              "dispute_status": "dispute_opened",
              "connector_status": "string",
              "connector_dispute_id": "string",
              "connector_reason": "string",
              "connector_reason_code": "string",
              "challenge_required_by": "2024-07-29T15:51:28.071Z",
              "connector_created_at": "2024-07-29T15:51:28.071Z",
              "connector_updated_at": "2024-07-29T15:51:28.071Z",
              "created_at": "2024-07-29T15:51:28.071Z"
            }
          ],
          "attempts": [
            {
              "attempt_id": "string",
              "status": "started",
              "amount": 6540,
              "order_tax_amount": 6540,
              "currency": "AED",
              "connector": "string",
              "error_message": "string",
              "payment_method": "card",
              "connector_transaction_id": "string",
              "capture_method": "automatic",
              "authentication_type": "three_ds",
              "created_at": "2022-09-10T10:11:12Z",
              "modified_at": "2022-09-10T10:11:12Z",
              "cancellation_reason": "string",
              "error_code": "string",
              "payment_token": "string",
              "payment_experience": "redirect_to_url",
              "payment_method_type": "apple_pay",
              "reference_id": "993672945374576J",
              "unified_code": "string",
              "unified_message": "string",
              "client_source": "string",
              "client_version": "string"
            }
          ],
          "captures": [
            {
              "capture_id": "string",
              "status": "started",
              "amount": 6540,
              "currency": "AED",
              "connector": "string",
              "authorized_attempt_id": "string",
              "connector_capture_id": "string",
              "capture_sequence": 0,
              "error_message": "string",
              "error_code": "string",
              "error_reason": "string",
              "reference_id": "string"
            }
          ],
          "capture_on": "2022-09-10T10:11:12Z",
          "capture_method": "automatic",
          "payment_method": "card",
          "payment_method_data": {
            "card": {
              "last4": "string",
              "card_type": "string",
              "card_network": "Visa",
              "card_issuer": "string",
              "card_issuing_country": "string",
              "card_isin": "string",
              "card_extended_bin": "string",
              "card_exp_month": "string",
              "card_exp_year": "string",
              "card_holder_name": "string"
            }
          },
          "payment_token": "187282ab-40ef-47a9-9206-5099ba31e432",
          "shipping": {
            "address": {
              "city": "New York",
              "country": "AF",
              "line1": "123, King Street",
              "line2": "Powelson Avenue",
              "line3": "Bridgewater",
              "zip": "08807",
              "state": "New York",
              "first_name": "John",
              "last_name": "Doe"
            },
            "phone": {
              "number": "9123456789",
              "country_code": "+1"
            },
            "email": "string"
          },
          "billing": {
            "address": {
              "city": "New York",
              "country": "AF",
              "line1": "123, King Street",
              "line2": "Powelson Avenue",
              "line3": "Bridgewater",
              "zip": "08807",
              "state": "New York",
              "first_name": "John",
              "last_name": "Doe"
            },
            "phone": {
              "number": "9123456789",
              "country_code": "+1"
            },
            "email": "string"
          },
          "order_details": "[{\n        \"product_name\": \"gillete creme\",\n        \"quantity\": 15,\n        \"amount\" : 900\n    }]",
          "return_url": "https://api.doopayment.com",
          "authentication_type": "three_ds",
          "next_action": {
            "redirect_to_url": "string",
            "type": "redirect_to_url"
          },
          "cancellation_reason": "string",
          "error_code": "E0001",
          "error_message": "Failed while verifying the card",
          "unified_code": "string",
          "unified_message": "string",
          "payment_experience": "redirect_to_url",
          "payment_method_type": "apple_pay",
          "ephemeral_key": {
            "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
            "created_at": 0,
            "expires": 0,
            "secret": "string"
          },
          "connector_transaction_id": "993672945374576J",
          "reference_id": "993672945374576J",
          "profile_id": "string",
          "attempt_count": 0,
          "authorization_count": 0,
          "external_authentication_details": {
            "authentication_flow": "challenge",
            "electronic_commerce_indicator": "string",
            "status": "started",
            "ds_transaction_id": "string",
            "version": "string",
            "error_code": "string",
            "error_message": "string"
          },
          "external_3ds_authentication_attempted": true,
          "expires_on": "2022-09-10T10:11:12Z",
          "payment_method_id": "string",
          "payment_method_status": "active",
          "updated": "2022-09-10T10:11:12Z",
          "extended_authorization_applied": true,
          "capture_before": "2024-07-29T15:51:28.071Z",
          "merchant_order_reference_id": "Custom_Order_id_123",
          "order_tax_amount": 0,
          "card_discovery": "manual"
        }
      },
      "timestamp": "2024-07-29T15:51:28.071Z"
    }