Refund
POST/:apiKey/refund
Records a refund transaction.
Either referenceTransactionId
or referenceUuid
must be provided.
Request
Path Parameters
Possible values: <= 50 characters
API key of connector.
- application/json
Body
required
Possible values: non-empty
and <= 50 characters
Your unique transaction ID.
Reference to the related transaction containing the merchant's reference (transactionId
).
Possible values: <= 50 characters
Reference to the related transaction containing the transaction reference (uuid
).
Possible values: Value must match regular expression ^(([0-9]+)|([0-9]+\.[0-9]{1,3}))$
Decimal amount separated by .
, maximum of 3 decimals.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Possible values: [success
, failed
, error_adapter
, error_internal
, cancelled
]
Default value: success
Status of Transaction.
Possible values: <= 50 characters
PSP's reference of Transaction.
Possible values: <= 50 characters
Token given by the adapter.
Date/Time of transaction processing, defaults to now()
.
RFC 3339 Internet Date/Time Format date-time
Possible values: <= 50 characters
Any additional ID if required by the Adapter.
Possible values: <= 50 characters
Any additional ID if required by the Adapter.
Possible values: <= 255 characters
Additional metadata for the merchant.
Possible values: <= 255 characters
Description of your transaction.
extraData
object
Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.
Possible values: <= 50 characters
Descriptor which is printed on card-holder's statement.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
customer
object
Information on the customer making a payment.
Possible values: <= 36 characters
Customer's ID.
Possible values: <= 50 characters
First name of the customer.
Possible values: <= 50 characters
Last name of the customer.
Birthdate of customer.
RFC 3339 Internet Date/Time Format full-date
.
Possible values: [M
, F
]
Gender of the customer.
Possible values: <= 50 characters
Line one of the customer's billing address.
Possible values: <= 50 characters
Line two of the customer's billing address.
Possible values: <= 50 characters
City of the customer's billing address.
Possible values: <= 16 characters
Postal code of the customer's billing address.
Possible values: <= 30 characters
State of the customer's billing address.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: <= 20 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Possible values: <= 50 characters
Line one of the customer's shipping address.
Possible values: <= 50 characters
Line two of the customer's shipping address.
Possible values: <= 50 characters
City of the customer's shipping address.
Possible values: <= 16 characters
Postal code of the customer's shipping address.
Possible values: <= 30 characters
State of the customer's shipping address.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: <= 20 characters
Possible values: <= 50 characters
Possible values: <= 255 characters
Possible values: <= 50 characters
Possible values: <= 20 characters
Possible values: <= 34 characters
IBAN of customer's bank account.
Possible values: <= 11 characters
BIC of customer's bank account.
creditcard
object
Credit card data.
Possible values: <= 60 characters
Name printed on card.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: >= 1
and <= 12
Expiration date - month.
Possible values: <= 9999
Expiration date - year.
Possible values: <= 6 characters
First 6 digits of card number.
Possible values: <= 4 characters
Last 4 digits of card number.
Possible values: <= 15 characters
Type of card.
error
object
Error/Decline reason data.
Possible values: <= 60 characters
Error message.
Possible values: <= 20 characters
Error code.
Possible values: <= 65535 characters
Error message of PSP.
Possible values: <= 20 characters
Error code of PSP.
Date and time of error, defaults to now()
.
RFC 3339 Internet Date/Time Format date-time
.
Responses
- 200
Push transaction response.
- application/json
- Schema
- Example (from schema)
- Success
- Error
Schema
- true
- false
success
string
required
Possible values: [true
, false
]
Whether the request was successful or not.
The assigned transaction uuid.
On error, this field will contain a description of the error.
Possible values: [MISSING_FIELDS
, INVALID_DATA
, DUPLICATE_ID
, INVALID_REFERENCE
]
The error code.
{
"success": true
}
Success
{
"success": true,
"uuid": "12c0b3f4aa1d02d1608a"
}
Error
{
"success": false,
"error_message": "The following fields are missing: registrationId",
"error_code": "MISSING_FIELDS"
}