Get refund details for an invoice

Nothing Found

Get refund details for an invoice

Retrieves refund details for the invoice specified by the invoice_id URL parameter.

Securitytilia_auth

Request

path Parameters

invoice_id

required

string (InvoiceId) <= 36 characters

The Invoice ID

Example: inv_2V2XDLW6zogChdShdFh8WKOhHii

query Parameters

status

string

Default: "REFUND-SUCCESS"

Filter refunds by refund status

Enum: "REFUND-SUCCESS" "REFUND-FAILED" "REFUND-REJECTED"

Responses

200

Successfully retrieved refunds for invoice.

400

Invalid input

401

Unauthorized access.

500

Service unavailable or server error.

get/v2/invoice/{invoice_id}/refunds

Request samples

curl
Python
Go
JS
PHP

Response samples

application/json

{"invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
"is_fully_refunded": false,
"refund_invoice_ids": ["inv_2MywYOdxxs0EzvwZOyG5tcb2Y3f",
"inv_2MyzNBNppUzHXfCoU2LB1PhoP6s"
],
"payments": {"<payment_id>": {"payment_id": "5b942db2-24eb-4884-a258-fbb67ece39ae",
"invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
"payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
"state": "CAPTURED",
"provider": "rebilly",
"psp_transaction_id": "094ffb76-2f1f-41a6-a397-16dbbe3488c9",
"request_amount": 100,
"request_currency": "USD",
"processing_amount": 95,
"processing_currency": "EUR",
"received_amount": 95,
"received_currency": "EUR",
"item_description": "A really nice house",
"source_client_id": "9722562e-89aa-4c00-adbe-9ade88d3faaf",
"ip_address": "127.0.0.1",
"created": "2022-08-02 15:46:25",
"updated": "2022-08-02 15:46:25",
"refunds": [{"refund_id": "daa77f1b-43f1-4bed-bd39-3a4feaab318b",
"refund_invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
"payment_id": "5b942db2-24eb-4884-a258-fbb67ece39ae",
"psp_refund_transaction_id": "51419716-7419-4b4d-8cac-17e7d2dec94c",
"amount": 95,
"currency": "EUR",
"refund_type": "line_item_refund",
"reason": "billing",
"sub_reason": "Charged twice",
"note": "Flag account",
"status": "REFUND-SUCCESS",
"line_item_id": "91393230-b38c-4731-a858-3ab6c063b8b1",
"created": "2022-08-02 15:46:25",
"updated": "2022-08-02 15:46:25"
}
],
"payment_method": {"payload": {"id": "ab72e6be-6173-40a0-9c96-546475113a05",
"method_class": "visa",
"display_string": "Visa ending in 1111",
"provider": "rebilly",
"processing_currency": "EUR",
"pm_state": "ACTIVE",
"created": "2022-08-02 15:46:25",
"updated": "2022-08-02 15:46:25"
}
}
}
},
"refunds": {"<refund_id>": {"refund_id": "daa77f1b-43f1-4bed-bd39-3a4feaab318b",
"refund_invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
"payment_id": "5b942db2-24eb-4884-a258-fbb67ece39ae",
"psp_refund_transaction_id": "51419716-7419-4b4d-8cac-17e7d2dec94c",
"amount": 95,
"currency": "EUR",
"refund_type": "line_item_refund",
"reason": "billing",
"sub_reason": "Charged twice",
"note": "Flag account",
"status": "REFUND-SUCCESS",
"line_item_id": "91393230-b38c-4731-a858-3ab6c063b8b1",
"created": "2022-08-02 15:46:25",
"updated": "2022-08-02 15:46:25"
}
},
"line_item_refunds": {"<line_item_id>": {"<refund_id>": {"refund_id": "daa77f1b-43f1-4bed-bd39-3a4feaab318b",
"refund_invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
"payment_id": "5b942db2-24eb-4884-a258-fbb67ece39ae",
"psp_refund_transaction_id": "51419716-7419-4b4d-8cac-17e7d2dec94c",
"amount": 95,
"currency": "EUR",
"refund_type": "line_item_refund",
"reason": "billing",
"sub_reason": "Charged twice",
"note": "Flag account",
"status": "REFUND-SUCCESS",
"line_item_id": "91393230-b38c-4731-a858-3ab6c063b8b1",
"created": "2022-08-02 15:46:25",
"updated": "2022-08-02 15:46:25"
}
}
}
}