--- title: "Expire payment instructions" method: PUT path: "/payment-instructions" tags: ["Payment Instructions"] --- # Expire payment instructions `PUT /payment-instructions` ## 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/payment-instructions` - Auth: API key in header `Api-Key` and API key in header `JWS-Signature` - TypeScript: (a function with typed inputs; its response is checked against the schema) This operation allows to expire one or more payment instructions assigned to a merchant. The payment instructions to be expired are identified by instruction id number. Only payment instructions with ACTIVE and FUTURE status can be expired. ## Headers - `Content-Type` 'application/json' | 'application/json;charset=UTF-8', required - `FSV-Interaction-Id` string, required - `Environment` string, required - `Institution-Number` string, required - `Internal-Merchant-Id` string, required ## Request body - PaymentInstructionsExpire[] - `instructionIdNumber` string, required: Internal unique Instruction ID number per merchant per instruction type generated by OmniPay. To get list of valid instructionIdNumber for a merchant, use Retrieve Payment Instructions endpoint in merchant maintenance API. ## Response `200` OK - InlineResponse400: An API response. The API response will be either a `SUCCESS` or an `ERROR`. A partial success or warning scenario will be treated as a Success with embedded messages in the meta data. A full success may not have messages. The API response will contain at least one of the following top level members." - `meta` MetaType: Supplementary information about the data. - `paging` PagingMetaType: Map containing pagination related information about data. - `count` integer: Total number of records present in system which can be retrieved. - `totalPages` integer: Total number of pages with maximum limit taken into account. - `currentOffset` integer: Current offset used in request. - `currentNumberOfRetrievedRecords` integer: Current number of retrieved records. - `maxLimit` integer: Maximum limit of records that can be retrieved. - `hasMoreRecords` boolean: Indicates if there are more records available. - `pageNumber` integer: Current page number. - `sorting` SortingMetaType: Map containing sorting related information about data. - `sort` string: Indicates the elements the current data is sorted with and the direction of sorting. - `messages` ErrorType[]: Messages related to request processing or response data - any additional information or warnings to be returned in the case of a successful API call. - `id` string: Generated message identifier for particular request, helping to locate server logs. - `code` string, required: Machine readable, unique code of the message related to particular case within operation execution. For complete list of codes please refer to API portal, messages page. - `title` string, required: Short description of the error. Not for displaying purposes. - `detail` string: Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes. - `source` SourceType: Object containing references to the source of the message. - `pointer` string: Indicates the element in the request document which caused the error. - `parameter` string: Indicates which query parameter caused the error. - `header` string: Indicates which header caused the error. - `data` object[]: "Contains the primary data to be returned as the API response. Use this object only when respnse type is an array. It will not be returned in case of error." - `errors` ErrorType[]: "Contains one or more error messages and is mutually exclusive with the data item. This will not be returned in success scenarios." - `id` string: Generated message identifier for particular request, helping to locate server logs. - `code` string, required: Machine readable, unique code of the message related to particular case within operation execution. For complete list of codes please refer to API portal, messages page. - `title` string, required: Short description of the error. Not for displaying purposes. - `detail` string: Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes. - `source` SourceType: Object containing references to the source of the message. - `pointer` string: Indicates the element in the request document which caused the error. - `parameter` string: Indicates which query parameter caused the error. - `header` string: Indicates which header caused the error. - `links` LinksType: Contains the links to retrieve the resources exposed as part of this API. - `self` string: The link to the primary resource being retrieved in the request. - `first` string: This is to provide the link to retrieve the first record/page. This SHOULD be used in case server provides pagination of the resource. - `last` string: This is to provide the link to retrieve the last record/page. This SHOULD be used in case server provides pagination of the resource. - `prev` string: This is to provide the link to retrieve the previous record/page. This SHOULD be used in case server provides pagination of the resource. - `next` string: This is to provide the link to retrieve the last record. This SHOULD be used in case server provides pagination of the resource ## Other responses - `400`: Invalid request - `401`: Authorization error - `403`: Forbidden error i.e. Consumer token credentials are valid but lack of permissions to do this action. - `404`: Record does not exist - `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)