Copy
curl --request POST \
--url https://app.tagadapay.com/api/public/v1/payments/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentId": "pay_123xyz",
"refundAll": true,
"metadata": {
"reason": "Customer request",
"initiatedBy": "merchant"
}
}
'Copy
{
"id": "pay_123xyz",
"refundedAmount": 1500,
"status": "partially_refunded",
"refund": {
"id": "ref_456",
"amount": 1500,
"currency": "USD",
"status": "succeeded",
"createdAt": "2024-03-20T10:30:00Z"
}
}payments
Refund payment
Process a full or partial refund for a payment
POST
/
api
/
public
/
v1
/
payments
/
refund
Copy
curl --request POST \
--url https://app.tagadapay.com/api/public/v1/payments/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentId": "pay_123xyz",
"refundAll": true,
"metadata": {
"reason": "Customer request",
"initiatedBy": "merchant"
}
}
'Copy
{
"id": "pay_123xyz",
"refundedAmount": 1500,
"status": "partially_refunded",
"refund": {
"id": "ref_456",
"amount": 1500,
"currency": "USD",
"status": "succeeded",
"createdAt": "2024-03-20T10:30:00Z"
}
}Authorizations
Enter your API key as: Bearer your-api-key
Body
application/json
Show child attributes
Show child attributes
Available options:
response-needed, under-review, forfeited, won, lost, unknown, refunded, refunded_externally Available options:
information-request, first-chargeback, second-chargeback, fraud, ethoca-alert, verifi-alert, paypal-claim, representment, rdr Available options:
0, 00, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.1, 10.2, 10.3, 10.4, 10.5, 11.1, 11.2, 11.3, 12, 12.1, 12.2, 12.3, 12.4, 12.5, 12.6, 12.7, 13.1, 13.2, 13.3, 13.4, 13.5, 13.6, 13.7, 13.8, 13.9, 30, 31, 34, 35, 37, 40, 41, 42, 46, 47, 49, 50, 51, 53, 54, 55, 57, 59, 60, 62, 63, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 85, 86, 93, 98, 1000, 2700, 2702, A, A01, A02, A08, AL, AP, AW, B, C02, C04, C05, C08, C14, C18, C28, C31, C32, CA, CD, CR, DA, DP, DP1, EX, F10, F14, F22, F24, F29, FR1, FR4, FR6, IC, IN, IS, LP, M01, M10, M49, N, NA, NC, P, P01, P03, P04, P05, P07, P08, P22, P23, R03, R13, RG, RM, RN1, RN2, SV, TF, TNM, UA01, UA02, UA03, UA10, UA11, UA12, UA18, UA20, UA21, UA22, UA23, UA28, UA30, UA31, UA32, UA38, UA99, bank_cannot_process, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, pre-chargeback-alert, product_not_received, product_unacceptable, subscription_canceled, unrecognized Response
Successful response
⌘I