API Reference
Log In
API Reference

Promotions

You can organise promotions with Crezco to reduce international payment fees.

📘

Creating a promotion

Discuss with the Crezco team to design and apply a promotion.

You can see which promotions are active on an Organisation with Get Organisation:

{
  "organisationId": "BC77508B-E3C8-4A03-8D96-3045B0DBD499",
  "partnerClientId": "Your-Unique-ID",
  "companiesHouseNumber": "11752182",
  "companyName": "Crezco LIMITED",
  //...
  "promotions": [
    {
      "promotionId": "example-promotion",
      "validFromUtc": "2024-08-19T15:43:56.858Z",
      "validToUtc": "2024-09-19T15:43:56.858Z"
    }
  ]
}
  • promotionId - This is a static ID given to one Promotion. The same Promotion ID will be found listed on every Organisation that has the promotion applied.
  • validFromUtc/validToUtc - ISO 8601 dates of when the Promotion is in effect for that particular Organisation.

Active Promotions automatically apply to all relevant Payables for that Organisation.

Details can be seen in Get payable estimates:

[
  {
    "payNetworkType": "Regular",
    "beneficiaryCountry": "string",
    "amount": {
      "currencyCode": "EUR",
      "amountInMinorUnits": 120000,
      "currencyConversion": {
        "isEstimated": true,
        "rate": 1.321,
        "fees": {
          "promotionId": "example-promotion",
          "transferFee": {
            "currencyCode": "GBP",
            "amountInMinorUnits": 100
          },
          "exchangeFee": {
            "currencyCode": "GBP",
            "amountInMinorUnits": 1275,
            "amountExcludingDiscountInMinorUnits": 2550
          }
        },
        "fundingAmount": {
          "currencyCode": "GBP",
          "amountInMinorUnits": 92215
        }
      }
    }
  }
]

Get pay run:

//...
"amount": {
    "currencyCode": "EUR",
    "amountInMinorUnits": 120000,
    "currencyConversion": {
      "isEstimated": false,
      "rate": 1.321,
      "fees": {
        "promotionId": "example-promotion",
        "transferFee": {
          "currencyCode": "GBP",
          "amountInMinorUnits": 100
        },
        "exchangeFee": {
          "currencyCode": "GBP",
          "amountInMinorUnits": 1275,
          "amountExcludingDiscountInMinorUnits": 2550
        }
      },
      "fundingAmount": {
        "currencyCode": "GBP",
        "amountInMinorUnits": 92215
      }
    }
  },

Details can also be found in Payable update webhook events.

  • promotionId- The ID of the promotion applied to the Payable. Only one promotion can apply to any given Payable. The IDs correlate to those seen in Get Organisation.
  • amountExcludingDiscountInMinorUnits - Found within a subobject of fees, this shows how much the fees would have been had the promotion not been applied.
  • amountInMinorUnits - This is always the actual fee cost to the payer, regardless of whether a promotion was applied to reach this figure.