List Refunds By Attempt

Deprecated

GET

/api/:account_id/payments/refunds/by_attempt/:processor_attempt_external_id

GET

/api/:account_id/payments/refunds/by_attempt/:processor_attempt_external_id

$ curl https://app.paymentkit.com/api/account_id/payments/refunds/by_attempt/processor_attempt_external_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 [
2   {
3     "id": "ref_8a7b6c5d4e3f2a1b",
4     "account_id": "acct_1234567890abcdef",
5     "charge_id": "ch_1J2K3L4M5N6O7P8Q",
6     "amount_atom": 250000,
7     "currency": "usd",
8     "status": "succeeded",
9     "created_at": "2024-01-15T08:45:00Z",
10     "updated_at": "2024-01-15T09:30:00Z",
11     "reason": "requested_by_customer",
12     "processor_refund_id": "re_1J2K3L4M5N6O7P8Q",
13     "failure_code": null,
14     "failure_message": null,
15     "processed_at": "2024-01-15T09:30:00Z",
16     "metadata": {
17       "order_id": "ORD-987654321",
18       "customer_note": "Refund issued due to product defect"
19     }
20   }
21 ]

List refunds for a processor attempt. Deprecated: Use /by_charge/{charge_id} instead.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processor_attempt_external_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

ID of the refund

account_idstring

ID of the account

charge_idstring

ID of the original charge

amount_atominteger

Refund amount in atoms

currencyenum

Currency code (e.g., USD)

statusenum

Status of a refund throughout its lifecycle.

created_atdatetime

updated_atdatetime

reasonenum or nullOptional

Reason for initiating a refund.

processor_refund_idstring or nullOptional

Processor’s refund ID (e.g., Stripe’s re_xxx)

failure_codestring or nullOptional

failure_messagestring or nullOptional

processed_atdatetime or nullOptional

metadatamap from strings to any or nullOptional

Errors

422

Unprocessable Entity Error