Request a balance refund
POST/v1/accounts/:accountId/refund
Request a balance refund
Request
Path Parameters
accountId stringrequired
The Account identifier to refund the balance of.
- application/json
Body
The request received from the client.
accountId stringrequired
The Account identifier to refund the balance of.
reference stringrequired
A reference for the refund.
Responses
- 200
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
timestamp date-timerequired
The timestamp of the refund.
accountId stringrequired
The Account identifier to request a refund for.
reference stringrequired
A reference for the refund.
{
"timestamp": "2024-07-29T15:51:28.071Z",
"accountId": "string",
"reference": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
code int32
An error status code describing the response.
| Enum Value | Description |
|---|---|
| 0 | OK |
| 1 | Cancelled |
| 2 | Unknown |
| 3 | InvalidArgument |
| 4 | DeadlineExceeded |
| 5 | NotFound |
| 6 | AlreadyExists |
| 7 | PermissionDenied |
| 8 | ResourceExhausted |
| 9 | FailedPrecondition |
| 10 | Aborted |
| 11 | OutOfRange |
| 12 | Unimplemented |
| 13 | Internal |
| 14 | Unavailable |
| 15 | DataLoss |
| 16 | Unauthenticated |
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]
message string
A developer-facing error message
details
object[]
A list of messages containing details about the errors
@type stringrequired
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Loading...