Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Payment Advice Service

Submit a Payment Advice Notification Transaction

Used for Payment Advice Notification Transaction.

post/payments/advice

Headers

Client-Request-Idstring required

A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

Timestampinteger required

Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

Message-Signaturestring required

Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

Request body

requestType'PaymentAdviceRequest' required

Payment Advice Service Request Type.

Example request

{
  "requestType": "PaymentAdviceRequest",
  "transactionAmount": {
    "total": 10.54,
    "currency": "EUR"
  },
  "paymentMethod": {
    "paymentType": "ALTERNATIVE_PAYMENT_METHOD",
    "provider": "PAYIT",
    "providerId": "020",
    "transactionId": "123",
    "customerId": "05"
  },
  "transactionDetails": {
    "transactionId": "838916029301",
    "transactionTimestamp": "2022-02-14T16:06:05Z",
    "origin": "ECOMMERCE",
    "adviceType": "SALE"
  },
  "merchantDetails": {
    "merchantName": "Merchant Name",
    "merchantId": "1234567890123456",
    "mcc": "5541",
    "alliance": "XYZ",
    "merchantAddress": {
      "street": "Mittlerer Hasenpfad",
      "houseNumberOrName": "59",
      "city": "Frankfurt am Main",
      "stateOrProvince": "HE",
      "postalCode": "60598",
      "country": "DEU"
    }
  }
}

Response

Created

responseType'PaymentAdviceResponse' required

Payment Advice Response.

Example response

{
  "responseType": "PaymentAdviceResponse",
  "transactionAmount": {
    "total": 10.54,
    "currency": "EUR"
  },
  "paymentMethod": {
    "paymentType": "ALTERNATIVE_PAYMENT_METHOD",
    "provider": "PAYIT",
    "providerId": "020",
    "transactionId": "123",
    "customerId": "05"
  },
  "transactionDetails": {
    "transactionId": "838916029301",
    "transactionTimestamp": "2022-02-14T16:06:05Z",
    "origin": "ECOMMERCE",
    "adviceType": "SALE"
  },
  "merchantDetails": {
    "merchantName": "Merchant Name",
    "merchantId": "1234567890123456",
    "mcc": "5541",
    "alliance": "XYZ",
    "merchantAddress": {
      "street": "Mittlerer Hasenpfad",
      "houseNumberOrName": "59",
      "city": "Frankfurt am Main",
      "stateOrProvince": "HE",
      "postalCode": "60598",
      "country": "DEU"
    }
  },
  "processorDetails": {
    "transactionResult": "APPROVED",
    "approvalCode": "00"
  }
}