Getting Started
Events
- POSTmerchant_updateddeprecated
- POSTrefund_succeededdeprecated
- POSTrefund_faileddeprecated
- POSTuser_payout.initiateddeprecated
- POSTuser_payout.paiddeprecated
- POSTuser_payout.faileddeprecated
- POSTpayout_report_requesteddeprecated
- POSTdata_session_completeddeprecated
- POSTpayout_createddeprecated
- POSTpayout_updateddeprecated
- POST
refund_failed
Copy
Ask AI
curl --request POST \
--url https://api.sand.getivy.de/api/service/webhook-event/refund_failed \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "refund_failed",
"date": "<string>",
"payload": {
"id": "<string>",
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"status": "failed",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"instantPaymentScheme": true,
"payerFinancialAddress": {
"type": "iban",
"iban": {
"iban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
},
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<unknown>"
],
"billingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"shippingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"paymentStatus": "not_settled",
"refunds": [
{
"id": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"description": "<string>",
"transactionId": "<string>"
}
],
"refundAmount": 1,
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"merchantFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>"
},
"paymentMethodType": "customer_balance",
"statusHistoryList": [
{
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"previousStatus": "failed"
}
],
"subaccountId": "<string>",
"subaccountLegalName": "<string>",
"statusClassification": {
"primary": "payment_authorisation_failed",
"secondary": "timeout"
},
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>",
"transactionId": "<string>"
}
}
'Deprecated
refund_failed
A refund initiated with /merchant/payment/refund failed
POST
/
api
/
service
/
webhook-event
/
refund_failed
refund_failed
Copy
Ask AI
curl --request POST \
--url https://api.sand.getivy.de/api/service/webhook-event/refund_failed \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "refund_failed",
"date": "<string>",
"payload": {
"id": "<string>",
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"status": "failed",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"instantPaymentScheme": true,
"payerFinancialAddress": {
"type": "iban",
"iban": {
"iban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
},
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<unknown>"
],
"billingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"shippingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"paymentStatus": "not_settled",
"refunds": [
{
"id": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"description": "<string>",
"transactionId": "<string>"
}
],
"refundAmount": 1,
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"merchantFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>"
},
"paymentMethodType": "customer_balance",
"statusHistoryList": [
{
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"previousStatus": "failed"
}
],
"subaccountId": "<string>",
"subaccountLegalName": "<string>",
"statusClassification": {
"primary": "payment_authorisation_failed",
"secondary": "timeout"
},
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>",
"transactionId": "<string>"
}
}
'Body
application/json
Data of the webhook event
The unique id for the webhook.
Available options:
refund_failed The date of the webhook.
The order data with failed refund information.
Show child attributes
Show child attributes
The unique id for the order.
The unique id for the merchantApp which initiated the order.
Same as appId
The legal name of the merchant which initiated the order.
A unique id for the order which can be set when creating the checkoutSession.
The amount of application fee collected with the order.
Required range:
x > 0The price object. All values in decimals, e.g. 0.13 for 13 cents.
The status of the order. As soon as this value is 'paid', you can ship the order.
Available options:
failed, canceled, processing, waiting_for_payment, paid, in_refund, refunded, refund_failed, partially_refunded, in_dispute, disputed, refused, finalizing The financial address of the payer associated with the order. Only available after successful PIS flow.
Show child attributes
Show child attributes
Available options:
iban, sort_code, bank_code, bban, wallet The customer-facing id of the order.
The project related to the order.
The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.
Required range:
x > 0The list of line items sold with the order.
Show child attributes
Show child attributes
Customer-facing name of the line item.
Accumulated cost in decimals. For example, for a lineItem with total price 3.00 and quantity 4, amount would be equal to 12.00.
An internal unique id stored to this line item.
Quantity of this lineItem.
An image of the line item. Valid URLs are accepted only.
Available options:
5045, 5065, 5094, 5192, 5193, 5499, 5655, 5691, 5712, 5722, 5812, 5814, 5912, 5977, 5999, 7629 Required range:
x > 0Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Available options:
AF, 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, 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, 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, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, 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, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Available options:
AF, 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, 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, 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, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, 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, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK Deprecated. The status of the payment.
Available options:
not_settled, failed, canceled, processing, requires_action, succeeded, in_refund, refunded, refund_failed, partially_refunded, disputed All partial and total refunds of this order.
Show child attributes
Show child attributes
The unique id of this refund request.
The unique id of this refund request. This can be set when requesting the refund.
The amount of the refund in decimals.
Required range:
x > 0The current status of this refund.
Available options:
pending, succeeded, failed, requires_action, partially_refunded The description of the refund.
The unique id of the transaction.
The total amount in the currency of all successful refunds for this order
Required range:
x > 0Deprecated. The email of the customer who completed the order.
The financial address of the merchant associated with the order. Only available when requested via order/details and therefore requires authentication.
Show child attributes
Show child attributes
Available options:
iban, sort_code, bank_code, bban, wallet The reference that will be shown on the bank statement of the customer. Only available after a successful DirectDebit initiation.
The destination bank account and statement reference for the order.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
iban, sort_code, bank_code, bban, wallet The bank statement reference of the payment for the order. This is the reference that will be visible on the bank statement.
Available options:
customer_balance, manual_bank_transfer Show child attributes
Show child attributes
Available options:
failed, canceled, processing, waiting_for_payment, paid, in_refund, refunded, refund_failed, partially_refunded, in_dispute, disputed, refused, finalizing Available options:
ORDER_CREATED, CHECKOUT_SESSION_ABORTED, PAYMENT_SUCCEEDED, PAYMENT_INITIATED, ORDER_CANCELED, ORDER_EXPIRED_BY_MERCHANT, ORDER_REFUND_INITIATED, ORDER_REFUNDED, REFUND_CHARGE_SUCCEEDED, REFUND_UPDATED, CHECKOUT_COMPLETED, PIS_PAYMENT_INITIATED, PIS_PAYMENT_UPDATED, PIS_PAYMENT_SUCCEEDED, PAYMENT_NOT_SETTLED, PAYMENT_INITIATION_FAILED, PAYMENT_CANCELED, PAYMENT_FAILED, CHECKOUT_SESSION_CREATED, EXPIRED_CHECKOUT_SESSION_ABORTED, DISPUTE, PENDING_PAYMENT_ATTEMPTS_FOUND, AML_FREEZE, MANUAL_FREEZE, MANUAL_UNFREEZE, ORDER_MANUALLY_REOPENED, ORDER_FINALIZATION_STARTED Available options:
failed, canceled, processing, waiting_for_payment, paid, in_refund, refunded, refund_failed, partially_refunded, in_dispute, disputed, refused, finalizing The subaccount id of the merchant.
Show child attributes
Show child attributes
Available options:
payment_authorisation_failed, payment_execution_failed, payment_abandoned Available options:
timeout, wrong_credentials, incorrect_2fa_response, payment_rejected, insufficient_funds, cancelled, connection_to_bank_failed, international_transfer_blocked, international_transfer_limit_exceeded, user_blocked, bank_error, instant_transfers_not_enabled, no_active_tan_methods_available, account_limit_exceeded, bank_under_maintenance, pin_blocked, payment_not_settled, unsupported_bank_account, online_banking_login_required, deutsche_bank_psu_migration, out_of_operational_hours The payment mode of the order. Can be either settlement or direct.
Available options:
direct, settlement The unique identifier of the customer who placed the order.
The unique identifier of the customer's bank.
The unique id of the transaction.
Response
200
OK
Was this page helpful?
⌘I