/feerefunds endpoint to refund fees to your account holder’s general purpose account (GPA).
Create fee refund
Action:POSTEndpoint:
/feerefunds
Use this endpoint to create a fee refund. Include the fee charge token path parameter to specify the fee to return.
If there are insufficient funds in your fee account to refund the fee, funds are drawn from your program reserve account.
Request body
| Fields | Description |
|---|---|
| original_fee_transaction_token string Optional | Unique identifier of the fee to be refunded. You can find this token in the response of the original /feecharges or /gpaorders request used to assess the standalone fee or from the webhook corresponding to the original request. You can also send a GET request to /transactions?type=fee.charges to retrieve a list of fee transactions.Allowable Values: 36 char max |
| tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
Response body
| Fields | Description |
|---|---|
| business_token string Returned | Specifies the business account holder to which the fee applies. Allowable Values: 1–36 chars |
| created_time datetime Returned | Date and time when the fee_charge object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fees array of objects Returned | Contains attributes that define characteristics of one or more fees. Allowable Values: Array of existing fees objects |
| fees[].fee object Returned | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| fees[].memo string Conditionally returned | Additional text that describes the fee transfer. Allowable Values: 1–99 chars |
| fees[].tags string Conditionally returned | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fees[].token string Returned | Unique identifier of the fee. Allowable Values: 1–36 chars |
| fees[].transaction_token string Returned | Unique identifier of the fee transaction. Allowable Values: 36 char max |
| tags string Conditionally returned | Metadata about the fee charge. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| token string Returned | Unique identifier of the fee transfer. Allowable Values: 1–36 chars |
| user_token string Returned | Specifies the user account holder to which the fee applies. Allowable Values: 1–36 chars |