Access tokens1

Account links1

Accounts15

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains5

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships11

Messages5

Notifications6

Partner Referral Requests6

Partners7

Payment Method Domains5

Payment methods3

Payment Rules9

Payments12

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews2

Setup Intents6

Shipments4

Social Accounts7

Stats2

Support channels3

Swaps4

Team Members5

Topups1

Trades5

Transfers4

Users18

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts3

Ad Campaigns2

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships4

Messages1

Payments7

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Verifications2

Refunds

Retrieve Refund

Returns one refund.

get/refunds/{id}

Response

refund retrieved

account_idstring nullable required

The account that issued the refund, prefixed biz_.

created_atstring required

When the refund was requested, as an ISO 8601 timestamp.

failure_messagestring nullable required

The provider's own explanation of the failure, or null.

Why the refund failed, normalized across providers. Null unless the refund failed or was canceled.

idstring required

Refund ID, prefixed rf_.

payment_idstring required

The payment this refund reverses, prefixed pay_.

providerstring required

The payment provider that processed the refund, such as paypal or coinbase.

provider_created_atstring nullable required

When the provider created the refund, as an ISO 8601 timestamp.

Why the refund was issued, when recorded.

reference_status'available' | 'pending' | 'unavailable' | 'null' nullable required

Whether a banking-network tracking reference is available for this refund.

reference_type'acquirer_reference_number' | 'retrieval_reference_number' | 'system_trace_audit_number' | 'null' nullable required

The kind of tracking reference, such as an acquirer reference number.

reference_valuestring nullable required

The tracking reference the buyer's bank can trace the refund by.

status'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled' required

Where the refund stands with the processor: pending, requires_action, succeeded, failed, or canceled.

updated_atstring required

When the refund last changed, as an ISO 8601 timestamp.

visa_rdrboolean required

True when the card network initiated the refund through Rapid Dispute Resolution.

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "failure_message": "Insufficient funds on the merchant balance.",
  "failure_reason": "insufficient_funds",
  "id": "rf_xxxxxxxxxxxxxx",
  "original_amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "payment_id": "pay_xxxxxxxxxxxxxx",
  "provider": "stripe",
  "provider_created_at": "2026-01-01T12:00:00.000Z",
  "reason": "duplicate",
  "reference_status": "available",
  "reference_type": "acquirer_reference_number",
  "status": "failed",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Changes

Changed in 8 of the 74 revisions of this API.102738

Sep 25, 2026c1dceb26e5051See the full diff
- ●
  added the new dispute_alert enum value to the response property for the response status
  response-property-enum-value-added
Sep 3, 2026697924df40d1101238See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  added subschema #2 to the response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the response's property type changed from number to no type for status
  response-property-type-changed
- ▲
  the response's property format changed from date-time to no format for status
  response-property-type-changed
- ▲
  the response's property format changed from date-time to no format for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to string null for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to string null for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  deleted the path request parameter id
  request-parameter-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new acquirer_reference_number enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new available enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new pending enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new retrieval_reference_number enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new system_trace_audit_number enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new unavailable enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new undefined enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new undefined enum value to the response property for the response status
  response-property-enum-value-added
- ○
  the security scope access_pass:basic:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  the security scope member:basic:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  the security scope member:email:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  the security scope member:phone:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  the security scope plan:basic:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  added the new optional header request parameter Api-Version-Date to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the adyen enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the airwallex enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the apple enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the braintree enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the checkout_dot_com enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the claritypay enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the coinbase enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the coinflow enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the dlocal enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the flex_pay enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the masspay enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the multi_psp enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the paypal enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the platform_balance enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the sequra enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the sezzle enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the splitit enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the stripe enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 28, 20264da7133b2de73See the full diff
- ●
  added the new flex_pay enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new flex_pay enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new gcash enum value to the ///// response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 26, 202686d0a97abfe55See the full diff
- ●
  added the new accel enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new culiance enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new nyce enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new pulse enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new star enum value to the ///// response property for the response status
  response-property-enum-value-added
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 2026715c4defcbbf1See the full diff
- ●
  added the new addi enum value to the ///// response property for the response status
  response-property-enum-value-added
Aug 19, 202623dfbe1a0d1f2See the full diff
- ●
  added the new modo enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new rapipago enum value to the ///// response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 2026ca841fbd67861See the full diff
- ●
  added the new braintree enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 202660bbb4a6ffbc2See the full diff
- ●
  added the new bank_wire enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new masspay enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.

Full history