Refund Payments
POST/payments
Use to endpoint to refund a payment.
Request
Header Parameters
appToken created by /auth/token
Format: Bearer xxxxxx...
- application/json
Body
required
data
object
A key for grouping different types of API data.
The type of transaction.
attributes
object
A key for grouping payment identification data.
Possible values: [cardRefund
]
The type of payment transaction.
The merchant account number.
Optional additional information to store with the call (optional).
transaction
object
A key for grouping payment transaction data. Required for all payment types except secondSplit
.
The transaction amount in cents.
The three-character code.
The invoice number for the transaction.
originalTransaction
object
A key for referencing the original split transaction.
The ID of the original split transaction.
Responses
- 201
Created
- application/json
- Schema
- Example (from schema)
- Result
Schema
links
object
URL for the current resource.
data
object
The type of transaction.
The payment transaction identification code.
attributes
object
A key for grouping payment identification data.
The application key.
transaction
object
A key for grouping payment identification data.
The banking entity response code.
The status of the transaction.
The transaction amount in dollars and cents.
The invoice number for the transaction.
The currency used for the transaction.
{
"links": {
"self": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"paymentType": "string",
"transaction": {
"code": "string",
"message": "string",
"amount": "string",
"invoice": "string",
"currency": "string"
}
}
}
}
{
"links": {
"self": "x"
},
"data": {
"type": "payments",
"id": "{paymentId}",
"attributes": {
"paymentType": "cardRefund",
"transaction": {
"code": "0",
"message": "Success",
"amount": "500",
"invoice": "123456",
"currency": "USD",
"authCode": "A11111",
"avsResult": "T",
"gross": "500",
"net": "450",
"grossMinusNet": "50",
"fee": "35",
"rate": "2.95"
}
}
}
}