Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

card-transactions

  1. card-transaction-representation
  2. card-transactions-representation
  3. create-card-transactions
  4. get-card-transaction
  5. get-card-transactions

1. card-transaction-representation

Description: A card transaction representation. A card transaction is a payment transaction executed with a card.

Properties
id
The card transaction id. Constraints: 36 characters or less, Read-Only.
amount
The transaction amount. Constraints: Number, 22 characters or less, Read-Write.
executionDate
The date the transaction should be executed. If not provided at creation, the next shorter possible date is chosen. Constraints: DateTime, ISO8601, Read-Write.
operation
The card operation. Text among authorization|debit|authorizationDebit|credit|refund|cancel|aliasAuthorization|aliasDebit|aliasCredit|aliasCancel|newAlias|aliasDelete, Read-Write.
returnCode
The return code. Constraints: Text, 12 characters or less, Read-Only.
result
The result. Constraints: Integer, 11 characters or less, Read-Only.
transactionId
The card transaction id. Constraints: Text, 50 characters or less, Read-Only.
reference
The card transaction reference. Constraints: Text, 250 characters or less, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionStatus
The card transaction execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
dateCreated
The date the resource has been created. Constraints: DateTime, ISO8601, Read-Only.

2. card-transactions-representation

Description: A collection of card transactions.

3. create-card-transactions (relation)

Description: Create one card transaction. A card alias with the given reference must exist.

Properties
amount
The transaction amount. Constraints: Number, 22 characters or less, Read-Write.
reference
The card transaction reference. Constraints: Text, 250 characters or less, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionDate
The date the transaction should be executed. If not provided at creation, the next shorter possible date is chosen. Constraints: DateTime, ISO8601, Read-Write.
operation
The card operation. Text among authorization|debit|authorizationDebit|credit|refund|cancel|aliasAuthorization|aliasDebit|aliasCredit|aliasCancel|newAlias|aliasDelete, Read-Write.
cardAlias » reference
The card alias reference. Constraints: Text, 250 characters or less, Read-Write.
Example: Create a card transaction
Request
POST follow(https://api.slimpay.net/alps#create-card-transactions) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw

{
    "cardAlias": {
        "reference": "129#democreditor#subscriber01"
    },
    "amount": 1,
    "reference": "Card Transaction 123"
}
Response
HTTP/1.1 201 Created
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 815

{
    "amount": "1.00",
    "dateCreated": "2017-03-02T16:55:54.456+0000",
    "executionDate": "2017-03-01T23:00:00.000+0000",
    "executionStatus": "toprocess",
    "id": "196c5daa-ff69-11e6-83f6-000000000000",
    "operation": "aliasDebit",
    "reference": "Card Transaction 123",
    "_links": {
        "https://api.slimpay.net/alps#get-card-alias": {
            "href": "https://api-sandbox.slimpay.net/card-aliases/bb78f52e-5881-11e5-949f-bbda0eef6d56"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/card-transactions/196c5daa-ff69-11e6-83f6-000000000000"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/card-transactions"
        }
    }
}

4. get-card-transaction (relation)

Description: Get one card transaction.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

5. get-card-transactions (relation)

Description: Get one one card transaction.

Properties
id
The card transaction id. Constraints: 36 characters or less, Read-Only.
Example: Get one card transaction by id
Request
GET follow(https://api.slimpay.net/alps#get-card-transactions) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1154

{
    "amount": "192.50",
    "dateCreated": "2017-02-21T14:13:57.000+0000",
    "executionDate": "2017-02-21T14:13:57.000+0000",
    "executionStatus": "processed",
    "id": "fbb749ed-f83f-11e6-84e7-000000000000",
    "operation": "aliasDebit",
    "reference": "1441803862",
    "result": 0,
    "returnCode": "00000",
    "_links": {
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/card-transactions/fbb749ed-f83f-11e6-84e7-000000000000"
        },
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#get-card-alias": {
            "href": "https://api-sandbox.slimpay.net/card-aliases/faffe0cb-f83f-11e6-84e7-000000000000"
        },
        "https://api.slimpay.net/alps#get-card": {
            "href": "https://api-sandbox.slimpay.net/cards/fb081e2c-f83f-11e6-84e7-000000000000"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/card-transactions"
        }
    }
}