---
title: "Submit a Payment Advice Notification Transaction"
method: POST
path: "/payments/advice"
tags: ["Payment Advice Service"]
---

# Submit a Payment Advice Notification Transaction

`POST /payments/advice`

## Request

- Base URL: `https://prod.emea.api.fiservapps.com/ipp/omnipay/acquirerprofile/v1.0`
- URL: `https://prod.emea.api.fiservapps.com/ipp/omnipay/acquirerprofile/v1.0/payments/advice`
- Auth: none declared. Required headers: `Client-Request-Id`, `Timestamp`, `Message-Signature`
- TypeScript: <https://skmtc.dev/fiserv/apis/acquirer-profile-in-design/docs/payments/advice/post.ts> (a function with typed inputs; its response is checked against the schema)

Used for Payment Advice Notification Transaction.

## Headers

- `Client-Request-Id` string, required
- `Timestamp` integer, required
- `Message-Signature` string, required

## Request body

- PaymentAdviceRequest
  - `requestType` 'PaymentAdviceRequest', required: Payment Advice Service Request Type.
  - `transactionAmount` TransactionAmount, required: Amount object of advice transaction in ISO 4217 Standard.
    - `total` number, required: The amount processed for the original transaction.
    - `currency` string, required: ISO 3 Currency Format. The currency of the original transaction.
  - `paymentMethod` PaymentMethod, required: The payment method used for this advice, such as an alternative payment method
    - `paymentType` 'ALTERNATIVE_PAYMENT_METHOD', required: Based on payment type other fields are populated.
    - `provider` string, required: Name of the Alternate Payment Method.
    - `providerId` string, required: Gateway Internal Code for Payment Provider.
    - `transactionId` string: Transaction ID of Alternate Payment Method.
    - `customerId` string: APM customer identifier.
  - `transactionDetails` TransactionDetails, required: Transaction details specific to each request based on business requirements.
    - `transactionId` string, required: The unique identifier of transaction.
    - `transactionTimestamp` string, date-time, required: Date and time the transaction occurred in YYYY-MM-DDThh:mm:ssZ format.
    - `origin` 'ECOMMERCE', required
    - `adviceType` 'SALE' | 'REFUND' | 'VOID', required: Payment Advice Type - SALE, REFUND, VOID
  - `merchantDetails` MerchantDetails, required: Used to pass merchant specific data during the transaction.
    - `merchantName` string, required: Merchant Name.
    - `merchantId` string, required: A unique ID used to identify the merchant.
    - `mcc` string, required: The merchant category code (MCC) is an industry standard four-digit number used to classify a business by the type of goods or services it provides.
    - `alliance` string, required: Used to identify name of alliance or partner.
    - `merchantAddress` Address, required: Model for address information.
      - `street` string: Street address.
      - `houseNumberOrName` string: Secondary address information, e.g. house number or name.
      - `city` string, required: City or locality.
      - `stateOrProvince` string: State or province.
      - `postalCode` string, required: ZIP code or postal code.
      - `country` string, required: ISO-3166-1 Alpha-2 Code or Alpha-3 Code or Numeric Code.

## Response `201`

Created

- PaymentAdviceResponse
  - `responseType` 'PaymentAdviceResponse', required: Payment Advice Response.
  - `transactionAmount` TransactionAmount, required: Amount object of advice transaction in ISO 4217 Standard.
    - `total` number, required: The amount processed for the original transaction.
    - `currency` string, required: ISO 3 Currency Format. The currency of the original transaction.
  - `paymentMethod` PaymentMethod, required: The payment method used for this advice, such as an alternative payment method
    - `paymentType` 'ALTERNATIVE_PAYMENT_METHOD', required: Based on payment type other fields are populated.
    - `provider` string, required: Name of the Alternate Payment Method.
    - `providerId` string, required: Gateway Internal Code for Payment Provider.
    - `transactionId` string: Transaction ID of Alternate Payment Method.
    - `customerId` string: APM customer identifier.
  - `transactionDetails` TransactionDetails, required: Transaction details specific to each request based on business requirements.
    - `transactionId` string, required: The unique identifier of transaction.
    - `transactionTimestamp` string, date-time, required: Date and time the transaction occurred in YYYY-MM-DDThh:mm:ssZ format.
    - `origin` 'ECOMMERCE', required
    - `adviceType` 'SALE' | 'REFUND' | 'VOID', required: Payment Advice Type - SALE, REFUND, VOID
  - `merchantDetails` MerchantDetails, required: Used to pass merchant specific data during the transaction.
    - `merchantName` string, required: Merchant Name.
    - `merchantId` string, required: A unique ID used to identify the merchant.
    - `mcc` string, required: The merchant category code (MCC) is an industry standard four-digit number used to classify a business by the type of goods or services it provides.
    - `alliance` string, required: Used to identify name of alliance or partner.
    - `merchantAddress` Address, required: Model for address information.
      - `street` string: Street address.
      - `houseNumberOrName` string: Secondary address information, e.g. house number or name.
      - `city` string, required: City or locality.
      - `stateOrProvince` string: State or province.
      - `postalCode` string, required: ZIP code or postal code.
      - `country` string, required: ISO-3166-1 Alpha-2 Code or Alpha-3 Code or Numeric Code.
  - `processorDetails` ProcessorDetails, required: Model for Response from Authorization System.
    - `transactionResult` 'APPROVED' | 'DECLINED' | 'FAILED': Response from Authorization System - Possible values APPROVED, DECLINED and FAILED.
    - `approvalCode` string: Processing Code from Authorization System

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal server error

---

[API](https://skmtc.dev/fiserv/apis/acquirer-profile-in-design.md) - [All operations](https://skmtc.dev/fiserv/apis/acquirer-profile-in-design/llms.txt) - [OpenAPI document](https://skmtc.dev/fiserv/apis/acquirer-profile-in-design/revisions/dd7ef6ce81a1?raw)