Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Manage Offer (Synchronous API)

Retire an offer

Retires an offer.

post/v1/offers/{OfferId}/retire

Path parameters

OfferIdnumber required

The identifier of the offer.

Headers

x-siteIdstring required

The site ID associated with the offer.

x-erid-as-oidstring

Set to true to use the external reference identifier (ERID) in the path instead of the offer identifier (offerId).

Response

Offer successfully retired.

idstring

Identifier of an offer.

statusstring

Status of an offer.

namestring

Name of an offer.

descriptionstring

Description of an offer.

externalReferenceOfferIdstring

The external reference identifier of the offer.

siteIdstring

site for which offer is created.

creationDatestring

Date of creation of an offer.

modificationDatestring

Date of modification of an offer.

Example response

{
  "id": "36094662050499",
  "status": "Retired",
  "name": "Offer_New_1",
  "description": "Offer_New_1",
  "externalReferenceOfferId": "Offer_New_1",
  "siteId": "paytest2",
  "creationDate": "2024-05-11T07:23:27.829Z",
  "modificationDate": "2024-05-11T08:14:23.148Z"
}