GET /v1/payments/{paymentId}

Used to get information about a payment, including information such as order and customer information, previous charges and refunds.

Response Class (Status 200)

{
  "payment": {
    "paymentId": "string",
    "summary": {
      "reservedAmount": 0,
      "chargedAmount": 0,
      "refundedAmount": 0,
      "cancelledAmount": 0
    },
    "consumer": {
      "billingAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "receiverLine": "string",
        "postalCode": "string",
        "city": "string",
        "country": "string"
      },
      "shippingAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "receiverLine": "string",
        "postalCode": "string",
        "city": "string",
        "country": "string"
      },
      "company": {
        "name": "string",
        "organisationNumber": "string",
        "email": "string",
        "phoneNumber": {
          "prefix": "string",
          "number": "string"
        },
        "merchantReference": "string"
      },
      "privatePerson": {
        "dateOfBirth": "2017-03-22T08:02:30.977Z",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": {
          "prefix": "string",
          "number": "string"
        },
        "merchantReference": "string"
      }
    },
    "paymentDetails": {
      "paymentType": "string",
      "paymentMethod": "string",
      "invoiceDetails": {
        "invoiceNumber": "string",
        "ocr": "string",
        "pdfLink": "string",
        "dueDate": "2017-03-22T08:02:30.977Z"
      },
      "cardDetails": {
        "maskedPan": "string",
        "expiryDate": "string"
      }
    },
    "orderDetails": {
      "amount": 0,
      "currency": "string",
      "reference": "string"
    },
    "checkout": {
      "url": "string"
    },
    "created": "2017-03-22T08:02:30.977Z",
    "refunds": [
      {
        "refundId": "string",
        "amount": 0,
        "state": "string",
        "lastUpdated": "2017-03-22T08:02:30.978Z",
        "orderItems": [
          {
            "reference": "string",
            "name": "string",
            "quantity": 0,
            "unit": "string",
            "unitPrice": 0,
            "taxRate": 0,
            "taxAmount": 0,
            "grossTotalAmount": 0,
            "netTotalAmount": 0
          }
        ]
      }
    ]
  }
}

Parameters

Parameter Value Description Parameter Type Data Type
paymentId (required)   path string
Authorization (required) Private api key header string

 

Response

HTTP Status Code Reason Response model
400 Bad request
{
  "errors": {}
}
401 Unauthorized  
404 Payment not found  
500 Unexpected error
{
  "message": "string",
  "code": "string",
  "source": "string"
}
Do you have question or need help?
Follow us
DIBS Payment Services
Stockholm +46 (0)8-527 525 00
Göteborg +46 031-600 800
København +45 7020 3077
Oslo +47 21 55 44 00