Skip to main content

Creates a new reversal transaction

PUT 
/transactions/:transactionId/reversals/:reversalTransactionId

Creates a new reversal transaction

Request​

Path Parameters

    transactionId uuidrequired

    The id of the transaction which should be returned.

    reversalTransactionId uuidrequired

    The id of the reversal transaction which should be returned.

Body

required

    description string

    Possible values: <= 100 characters

    A short text describing the purpose of the transaction

    triggeredBy

    object

    required

    The entry point via which the customer was registered or her/his data was updated

    For DistributorB2B the following details are mandatory: distributorId, shopId, posDevice (id, type), operatorId

    For MerchantB2B the following details are mandatory: merchantId

    For PosApp the following details are mandatory: distributorId, shopId, posDevice (id, type, appInstallationId), operatorId

    For Admin the following details are mandatory: operatorId

    For System there are no mandatory fields

    type stringrequired

    Possible values: [DistributorB2B, MerchantB2B, PosApp, Admin, System]

    distributorId uuid

    The distributor at which the transaction got created/modified, in case the type is DistributorB2B

    shopId

    object

    The distributor's shop at which the transaction got created/modified

    anyOf

    Arbitrary string if type is DistributorB2B

    string

    posDevice

    object

    The device at which the transaction was triggered

    id stringrequired

    Possible values: <= 50 characters

    The unique id of the device

    type stringrequired

    Possible values: [Till, Terminal, Mobile]

    The type of the device

    appInstallationId uuid

    The unique id of the app installation on the device

    operatorId

    object

    The cashier/operator who performed the transaction

    anyOf

    Arbitrary string if type is DistributorB2B

    string

    customerId string

    The customer who performed the transaction, in case the type is SelfServicePortal

    merchantId string

    The merchant who performed the transaction, in case the type is SelfServicePortal

    externalReference ExternalReference (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[\d\p{L}]([\d\p{L}\-\. ]{0,48}[\d\p{L}])$

    A reference to a transaction in an external system e.g. bank transfer.

Responses​

Successful response

Response Headers

  • Location

    string

    The relative URI of the transaction.

  • ETag

    string

    The current version identifier of the transaction.

Schema

    id uuid

    The id of the transaction

    type TransactionType (string)required

    Possible values: [PassthroughDeposit, PassthroughWithdrawal, CustomerToMerchantTransfer, CustomerToMerchantPassthrough, MerchantToCustomerTransfer, MerchantToCustomerPassthrough]

    The type of the transaction, defining which other transaction properties are mandatory, e.g. PassthroughDeposit requires customerId, merchantId, documents, card

    amount numberrequired

    Possible values: <= 10000

    The amount of the transaction

    currency stringrequired

    The currency code as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217).

    customerId uuidrequired

    The unique id of the customer participating in the transaction. Available if type is Passthrough

    description TransactionDescription (string)

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[\p{L}0-9'\.\-\\!\$\%\&\/\\\(\)\[\]\{\}\=\?\+\*\#\;\,\:_\"]{1,100}$

    A short text describing the purpose of the transaction

    referenceTransactionId uuid

    The id of another existing transaction referenced by the current one. Available if type is *Reversal or *Refund

    state TransactionState (string)

    Possible values: [Declined, Completed, Cancelled]

    The current(last) state of the transaction.

    status TransactionStatus (string)

    Possible values: [BeingProcessed, Succeeded, Failed]

    The overall status/outcome of the transaction.

    createdOn date-time

    The server-generated timestamp of the initial creation of the transaction record, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time

    distributorId uuidrequired

    The unique id of the distributor the account balance of whom will be affected. Available if type is DistributorPayment*

    externalReference ExternalReference (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[\d\p{L}]([\d\p{L}\-\. ]{0,48}[\d\p{L}])$

    A reference to a transaction in an external system e.g. bank transfer.

Loading...