HomeGetting StartedSolutionsPlatformsGlobal Integration
DocsRecipesAPI referenceChangelogAPI ReferenceRecipesChangelog
HomeGetting StartedSolutionsPlatformsGlobal IntegrationLog In
API reference

Refund Transaction

post
https://api.global.sandbox.affirm.com/api/v1/transactions//refund

Refunds a transaction. You can either refund the entire amount or specify a partial amount.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A unique ID representing the transaction’s loan or charge ID.

Body Params

The request body used to refund a transaction.

integer | null
≥ 1

The amount to be refunded in cents. If the request omits this parameter, the entire remaining amount on the transaction will be fully refunded.

string | null

An optional, unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.

metadata
object

Unstructured metadata containing any additional data to be passed into each refund request.

Headers
string

Unique identifier pre-generated by the client and used by the server to recognize successive calls to the same endpoint. This is required for Split Capture and encouraged for single transaction functionality. Note: If a request fails or times out, use the same idempotency key to retry the operation without risk of double-processing. For details, see the Idempotency section on About Split Capture.

string
required

Required param to identify the country in which Affirm is used and uses an "alpha-3" three-letter country code. Supported countries are the United States (USA), Canada (CAN), and the United Kingdom (GBR).

Responses

Updated 5 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 5 months ago