How may we help?

Introduction

A Payment represents a single payment request by a set Contact.

Endpoints

GET /payments?pageNumber={x}&pageSize={y}&startDate={yyyy-mm-dd}&endDate={yyyy-mm-dd}&state={z}

Get a list of Payments with a given state, at a given size by a given offset and date limitation. All parameters are optional.

Response

HTTP 200 Example

{
  "pageNumber": 1,
  "pageSize": 50,
  "startDate": "yyyy-mm-dd",
  "endDate": "yyyy-mm-dd",
  "list": [
    {
      "paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
      "...": "..."
    },
    {
      "paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
      "...": "..."
    }
  ]
}

GET /payments?search={paymentGatewayReferenceId}

Get an array of Payments by a given search string matching the paymentGatewayReferenceId.

Response

HTTP 200 Example

[
  {
    "paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "...": "..."
  }
]

GET /payment/{guid}

Get a single Payment.

Response

HTTP 200 Example

{
  "paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
  "createdTs": "2019-01-01 00:00:00 +0100",
  "paymentType": "",
  "contactGuid": "",
  "agreementGuid": "",
  "amount": 100.0,
  "taxDeductable": true,
  "state": "",
  "dueDateTs": "",
  "chargedTs": "",
  "failedTs": "",
  "errorCode": "",
  "errorDescription": "",
  "currencyCode": "DKK",
  "paymentGateway": "",
  "paymentGatewayReferenceId": "",
  "paymentGatewayTransactionId": "",
  "purposeAccountingCode": "",
  "paymentMethodAccountingCode": "",
  "amountRefunded": 0.0,
  "paymentMethodGuid": "",
  "subscriptionGuid": "",
  "paymentSessionGuid": "",
  "dataSetGuid": "",
  "externalLink": "",
  "metaData": {
    "card": {
      "type": "Dankort",
      "cardNumber": "457150XXXXXX7478",
      "acquirer": "Nets/Teller",
      "orderId": "4200xxxxx",
      "transactionId": "88821321"
    },
    "bs": {
      "customerNumber": "605XXX",
      "mandate": "956964XXX",
      "ocr": "1231352356235",
      "dataSupplierReferenceId": "GSFDGSERG",
      "paymentSlipDispatchMethod": "195",
      "transactionCode": "297"
    },
    "mps": {
      "externalId": "1568581537XXX"
    },
    "sms": {
      "msisdn": "4512345678"
    }
  }
}

GET /payment/{guid}/receipt (deprecated)

Get a single Payment's Receipt Planned

Response

HTTP 200 Example

{
  "receiptGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
  "...": "..."
}

GET /payment/{guid}/transactions

Get a list of Transactions for a single Payment.

Response

HTTP 200 Example

[
  {
    "transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "transactionType": "charge",
    "amount": 100.0,
    "...": "..."
  },
  {
    "transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "transactionType": "refund",
    "amount": 100.0,
    "...": "..."
  }
]

GET /payment/{guid}/chargeAttempts

Get a list of Charge Attempts for a single Payment.

Response

HTTP 200 Example

[
  {
    "chargeAttemptGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "...": "..."
  },
  {
    "chargeAttemptGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "...": "..."
  }
]

GET /payment/{guid}/orderLines (deprecated)

Get a list of Order Lines for a single Payment Planned

Response

HTTP 200 Example

[
  {
    "orderLineGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "...": "..."
  },
  {
    "orderLineGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
    "...": "..."
  }
]

PATCH /payment/{guid}

Update a single Payment using add, replace or remove operations.

Request

The following must be provided as the request body:

[
  {
    "op": "add|replace|remove",
    "path": "/externalId",
    "value": "1001"
  }
]

Response

POST /payment/{guid}/Refund

Refund a Payment.

Request

The following must be provided as the request body:

{
  "amount": 100.0,
  "callbackUrl": "https://yourdomain.tld/"
}

Response

A callback is sent when the refund operation either fails or succeeds. Please see Refund for entity properties.

POST body example

{
  "paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
  "transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
  "refundGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx"
}

POST /payment/{guid}/Cancel

Cancel a Pending Payment.

Response

A callback is sent when the cancel operation either fails or succeeds.

Properties

Payment Gateway Providers

Payment Types

Payment Method Types

Payment States

Following is a list of Payment states:

Payment State Diagram for recurring payments

Payment State Diagram for single payments

Payment Cancel Codes

For further examples and ties to other entities, please see: Error and Cancel Codes

Payment Error Codes

For further examples and ties to other entities, please see: Error and Cancel Codes