Skip to main content

Refund

POST 

/:apiKey/refund

Records a refund transaction.

warning

Either referenceTransactionId or referenceUuid must be provided.

Request

Path Parameters

    apiKey stringrequired

    Possible values: <= 50 characters

    API key of connector.

Body

required

    transactionId stringrequired

    Possible values: non-empty and <= 50 characters

    Your unique transaction ID.

    referenceTransactionId string

    Reference to the related transaction containing the merchant's reference (transactionId).

    referenceUuid string

    Possible values: <= 50 characters

    Reference to the related transaction containing the transaction reference (uuid).

    amount Amount (string)required

    Possible values: Value must match regular expression ^(([0-9]+)|([0-9]+\.[0-9]{1,3}))$

    Decimal amount separated by ., maximum of 3 decimals.

    currency Currency (string)required

    Possible values: Value must match regular expression ^[A-Z]{3}$

    ISO 4217 three-letter currency code.

    status TransactionStatus (string)

    Possible values: [success, failed, error_adapter, error_internal, cancelled]

    Default value: success

    Status of Transaction.

    adapterTxId string

    Possible values: <= 50 characters

    PSP's reference of Transaction.

    adapterToken string

    Possible values: <= 50 characters

    Token given by the adapter.

    createdAt date-time

    Date/Time of transaction processing, defaults to now().

    RFC 3339 Internet Date/Time Format date-time

    additionalId1 string

    Possible values: <= 50 characters

    Any additional ID if required by the Adapter.

    additionalId2 string

    Possible values: <= 50 characters

    Any additional ID if required by the Adapter.

    merchantMetaData string

    Possible values: <= 255 characters

    Additional metadata for the merchant.

    description string

    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.

    property name* string
    descriptor string

    Possible values: <= 50 characters

    Descriptor which is printed on card-holder's statement.

    buyerCountry Country (string)

    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.

    identification string

    Possible values: <= 36 characters

    Customer's ID.

    firstName string

    Possible values: <= 50 characters

    First name of the customer.

    lastName string

    Possible values: <= 50 characters

    Last name of the customer.

    birthDate date (string)

    Birthdate of customer.

    RFC 3339 Internet Date/Time Format full-date.

    gender string

    Possible values: [M, F]

    Gender of the customer.

    billingAddress1 string

    Possible values: <= 50 characters

    Line one of the customer's billing address.

    billingAddress2 string

    Possible values: <= 50 characters

    Line two of the customer's billing address.

    billingCity string

    Possible values: <= 50 characters

    City of the customer's billing address.

    billingPostcode string

    Possible values: <= 16 characters

    Postal code of the customer's billing address.

    billingState string

    Possible values: <= 30 characters

    State of the customer's billing address.

    billingCountry Country (string)

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2 country code.

    billingPhone string

    Possible values: <= 20 characters

    shippingFirstName string

    Possible values: <= 50 characters

    shippingLastName string

    Possible values: <= 50 characters

    shippingCompany string

    Possible values: <= 50 characters

    shippingAddress1 string

    Possible values: <= 50 characters

    Line one of the customer's shipping address.

    shippingAddress2 string

    Possible values: <= 50 characters

    Line two of the customer's shipping address.

    shippingCity string

    Possible values: <= 50 characters

    City of the customer's shipping address.

    shippingPostcode string

    Possible values: <= 16 characters

    Postal code of the customer's shipping address.

    shippingState string

    Possible values: <= 30 characters

    State of the customer's shipping address.

    shippingCountry Country (string)

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2 country code.

    shippingPhone string

    Possible values: <= 20 characters

    company string

    Possible values: <= 50 characters

    email string

    Possible values: <= 255 characters

    ipAddress string

    Possible values: <= 50 characters

    nationalId string

    Possible values: <= 20 characters

    iban string

    Possible values: <= 34 characters

    IBAN of customer's bank account.

    bic string

    Possible values: <= 11 characters

    BIC of customer's bank account.

    creditcard

    object

    Credit card data.

    cardHolder string

    Possible values: <= 60 characters

    Name printed on card.

    country Country (string)

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2 country code.

    expiryMonth int32

    Possible values: >= 1 and <= 12

    Expiration date - month.

    expiryYear int32

    Possible values: <= 9999

    Expiration date - year.

    firstSixDigits string

    Possible values: <= 6 characters

    First 6 digits of card number.

    lastFourDigits string

    Possible values: <= 4 characters

    Last 4 digits of card number.

    type string

    Possible values: <= 15 characters

    Type of card.

    error

    object

    Error/Decline reason data.

    message stringrequired

    Possible values: <= 60 characters

    Error message.

    code stringrequired

    Possible values: <= 20 characters

    Error code.

    adapter_error_message stringrequired

    Possible values: <= 65535 characters

    Error message of PSP.

    adapter_error_code string

    Possible values: <= 20 characters

    Error code of PSP.

    created date-time

    Date and time of error, defaults to now().

    RFC 3339 Internet Date/Time Format date-time.

Responses

Push transaction response.

Schema

    success

    string

    required

    Possible values: [true, false]

    Whether the request was successful or not.

    uuid string

    The assigned transaction uuid.

    property name* any
Loading...