Gift Cards

Deposit

schedule 5 min read

Deposit funds to the gift card.

Edit "Deposit" on GitHub

Deposit

Request

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
27
28
POST /api/payments/payment-account/{paymentAccountId}/payment/deposit HTTP/1.1
Authorization: Bearer <AccessToken>
Hmac: HMAC authentication filter
Content-Type: application/json

{
    "accountIdentifier": {
        "accountId": 123456789,
        "accountKey": 7013360000000001000,
        "cvc": 123,
        "encryptedPin": "000",
        "expiryDate": "12/20",
        "securityCode": 123,
        "track2": "7013360000000000000=2012125123"
    },
    "additionalData": "string",
    "amount": 10000,
    "currency": "NOK",
    "description": "string",
    "merchant": {
        "merchantName": "Test Merchant 101",
        "terminalId": 12345
    },
    "paymentOrderRef": "UUID",
    "paymentTransactionRef": "UUID",
    "repeat": true,
    "stan": 123456
}
Required Field Type Description
check accountIdentifier Object  
  accountId string Swedbank Pay internal id for card/account.
check accountKey string Primary Account Number (PAN) for card/account. This is mandatory if ‘track2’ is not present.
  cvc string Card Verification Code.
  encryptedPin string If ‘000’ is set on authorization request, encrypted PIN block will be returned here.
  expiryDate string Expiry date on card (only applicable for PaymentInstrumentType ‘creditcard’) where expiry date is printed on card. Format MM/YY
  securityCode string Card Security Code.
  track2 string Track 2 excluding start and end sentinel.
  additionalData string Optional additional data stored on transaction.
check amount integer Total amount of Payment (in cents), ie. 100Kr -> 10000.
check currency string Currency for Payment.
  description string Payment description.
check merchant object  
check merchantName string Name of merchant where payment was performed
  terminalId string Used to identify terminal.
check paymentOrderRef string Unique ID to bind 2-phase transactions.
check paymentTransactionRef string Unique ID for each payment.
  repeat boolean Notifies this is a repeat message.
  stan string Systems trace audit number.

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
    "_links": [
        {
            "deprecation": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "rel": "string",
            "templated": true,
            "title": "string",
            "type": "string"
        }
    ],
    "accountIdentifier": {
        "accountId": 123456789,
        "accountKey": 7013360000000001000,
        "cvc": 123,
        "encryptedPin": "000",
        "expiryDate": "12/20",
        "securityCode": 123,
        "track2": "7013360000000000000=2012125123"
    },
    "allowedProductIds": [
        "string"
    ],
    "amount": 0,
    "created": "2020-05-11T09:58:33.431Z",
    "currency": "string",
    "description": "string",
    "issuer": {
        "acquirerId": "string",
        "acquirerName": "string",
        "issuerId": "string",
        "issuerName": "string",
        "settlementProvided": true
    },
    "merchant": {
        "merchantName": "Test Merchant 101",
        "terminalId": 12345
    },
    "operation": "string",
    "paymentId": "string",
    "paymentOrderRef": "string",
    "paymentTransactionRef": "string",
    "remainingCancelAmount": 0,
    "remainingCaptureAmount": 0,
    "remainingReversalAmount": 0,
    "state": "OK",
    "transmissionTime": "2020-05-11T09:58:33.431Z",
    "updated": "2020-05-11T09:58:33.431Z"
}
Field Type Description
state enum OK, FAILED, REVERSED or DUPLICATE. The state of the transaction.