MobilePay Online – Reversal

Reversal

This transaction is used when a captured payment needs to be reversed.

Create reversal transaction

The create-reversal operation will reverse a previously captured payment.

Request

1
2
3
4
5
6
7
8
9
10
11
12
13

POST /psp//payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/reversals HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

{
    "transaction": {
        "amount": 1500,
        "vatAmount": 0,
        "description": "Test Reversal",
        "payeeReference": "ABC123"
    }
}

Field	Type	Description
`transaction`	`object`	The `object` representation of the generic transaction resource.
└➔ `amount`	`integer`	The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK.
└➔ `vatAmount`	`integer`	The payment’s VAT (Value Added Tax) `amount`, entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK. The `vatAmount` entered will not affect the `amount` shown on the payment page, which only shows the total `amount`. This field is used to specify how much of the total `amount` the VAT will be. Set to `0` (zero) if there is no VAT `amount` charged.
└➔ `description`	`string`	A textual description of the `reversal`.
└➔ `payeeReference`	`string(30*)`	A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation. See `payeeReference` for details.

The reversal resource contains information about the newly created reversal transaction.

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

HTTP/1.1 200 OK
Content-Type: application/json

{
    "payment": "/psp//payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "reversal": {
        "id": "/psp//payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/reversal/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
        "transaction": {
            "id": "/psp//payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/transactions/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
            "created": "2016-09-14T01:01:01.01Z",
            "updated": "2016-09-14T01:01:01.03Z",
            "type": "Reversal",
            "state": "Completed",
            "number": 1234567890,
            "amount": 1000,
            "vatAmount": 250,
            "description": "Test transaction",
            "payeeReference": "AH123456",
            "failedReason": "",
            "isOperational": false,
            "operations": []
        }
    }
}

Property	Type	Description
`payment`	`string`	The relative URI of the payment this `reversal` transaction belongs to.
`reversal`	`object`	The `reversal` resource contains information about the `reversal` transaction made against a card payment.
└➔ `id`	`string`	The relative URI of the created `reversal`transaction.
└➔ `transaction`	`object`	The object representation of the generic transaction resource.
└─➔ `id`	`string`	The relative URI of the current transaction resource.
└─➔ `created`	`string`	The ISO-8601 date and time of when the transaction was created.
└─➔ `updated`	`string`	The ISO-8601 date and time of when the transaction was updated.
└─➔ `type`	`string`	Indicates the transaction type.
└─➔ `state`	`string`	Indicates the state of the transaction, usually `initialized`, `completed` or`failed`. If a partial has been done and further transactionsare possible, the state will be `awaitingActivity`.
└─➔ `number`	`string`	The transaction number, useful when there’s need to reference the transaction in human communication. Not usable for programmatic identification of the transaction, where `id` should be used instead.
└─➔ `amount`	`integer`	The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK.
└─➔ `vatAmount`	`integer`	The payment’s VAT (Value Added Tax) `amount`, entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK. The `vatAmount` entered will not affect the `amount` shown on the payment page, which only shows the total `amount`. This field is used to specify how much of the total `amount` the VAT will be. Set to `0` (zero) if there is no VAT `amount` charged.
└─➔ `description`	`string`	A 40 character length textual description of the purchase.
└─➔ `payeeReference`	`string`	A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation. See `payeeReference` for details.
└─➔ `failedReason`	`string`	The human readable explanation of why the payment failed.
└─➔ `isOperational`	`boolean`	`true` if the transaction is operational; otherwise `false` .
└─➔ `operations`	`array`	The array of operations that are possible to perform on the transaction in its current state.

The reversals resource lists the reversal transactions (one or more) on a specific payment.

Request

1
2
3
4

GET /psp//payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/reversals HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

The reversal resource contains information about the reversal transaction made against a mobilepay payment. You can return a specific reversal transaction by performing a GET request towards the specific transaction’s id.

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

HTTP/1.1 200 OK
Content-Type: application/json

{
    "payment": "/psp/mobilepay/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "reversals": { 
        "id": "/psp/mobilepay/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/reversals",
        "reversalList": [{
            "id": "/psp/mobilepay/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/reversals/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
            "transaction": {
                "id": "/psp/mobilepay/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/transactions/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
                "created": "2016-09-14T01:01:01.01Z",
                "updated": "2016-09-14T01:01:01.03Z",
                "type": "Reversal",
                "state": "Completed",
                "number": 1234567890,
                "amount": 1000,
                "vatAmount": 250,
                "description": "Test transaction",
                "payeeReference": "AH123456",
                "isOperational": false,
                "operations": []
            }
        }]
    }
}

Field	Type	Required
`payment`	`string`	The relative URI and unique identifier of the `payment` resource this `reversals` belongs to. Please read about URI Usage to understand how this and other URIs should be used in your solution.
`reversals`	`object`	The current `reversals` resource.
└➔ `id`	`string`	The relative URI and unique identifier of the `reversals` resource this `reversals` belongs to. Please read about URI Usage to understand how this and other URIs should be used in your solution.
└➔ `reversalList`	`array`	The array of reversal transaction objects.
└➔ `reversalList[]`	`object`	The reversal transaction object described in the `reversal` resource below.
└─➔ `id`	`string`	The relative URI and unique identifier of the `transaction` resource this `reversals` belongs to. Please read about URI Usage to understand how this and other URIs should be used in your solution.
└─➔ `created`	`string`	The ISO-8601 date and time of when the transaction was created.
└─➔ `updated`	`string`	The ISO-8601 date and time of when the transaction was updated.
└─➔ `type`	`string`	Indicates the transaction type.
└─➔ `state`	`string`	Indicates the state of the transaction, usually `initialized`, `completed` or`failed`. If a partial reversal has been done and further transactionsare possible, the state will be `awaitingActivity`.
└─➔ `number`	`string`	The transaction `number`, useful when there’s need to reference the transaction in human communication. Not usable for programmatic identification of the transaction, where `id` should be used instead.
└─➔ `amount`	`integer`	The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK.
└─➔ `vatAmount`	`integer`	The payment’s VAT (Value Added Tax) `amount`, entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK. The `vatAmount` entered will not affect the `amount` shown on the payment page, which only shows the total `amount`. This field is used to specify how much of the total `amount` the VAT will be. Set to `0` (zero) if there is no VAT `amount` charged.
└─➔ `description`	`string`	A 40 character length textual description of the purchase.
└─➔ `payeeReference`	`string`	A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation. See `payeeReference` for details. In Invoice Payments `payeeReference` is used as an invoice/receipt number, if the `receiptReference` is not defined.
└─➔ `isOperational`	`bool`	`true` if the transaction is operational; otherwise `false`.
└─➔ `operations`	`array`	The array of operations that are possible to perform on the transaction in its current state.

Reversal Sequence

sequenceDiagram
  activate Merchant
  Merchant->>-SwedbankPay: POST [reversals]
  activate SwedbankPay
  SwedbankPay-->>-Merchant: transaction resource