API reference · Credit

Buy now pay later products

GET/bnpl/productList a programme's products
GET/bnpl/product/{reference}Retrieve a product

GET List a programme's products

GET /bnpl/product

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Query parameters

Name	Default
`programmeReference`	Optional

Example

Response: GenericResponseListProductResponse

curl -X GET "https://api.bridgemoni.com/bnpl/product?programmeReference=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "programmeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "string",
      "scheduleKind": "EQUAL_SPLIT",
      "pricingKind": "FREE_TO_CUSTOMER",
      "regulatoryClass": "EXEMPT_DPC",
      "status": "DRAFT",
      "instalmentCount": 0,
      "periodLength": 0,
      "periodUnit": "DAY",
      "downPaymentBasis": "NONE",
      "downPaymentValue": 0,
      "rateBasisPoints": 0,
      "dayCountConvention": "ACT_365",
      "lateChargeKind": "NONE",
      "lateChargeValue": 0,
      "lateChargeCapBasis": 0,
      "graceDays": 0,
      "coolingOffHours": 0,
      "earlySettlementRebate": "PRO_RATA",
      "collateralKind": "NONE",
      "allocationOrder": "OLDEST_FIRST",
      "minAmount": 0,
      "maxAmount": 0,
      "affordabilityFactor": 0,
      "shariaBoardReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "shariaApprovedOn": "2026-09-25",
      "priceGrid": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "band": "NO_SCORE",
          "rateBasisPoints": 0,
          "limitCeiling": 0
        }
      ],
      "specimenAtMinimum": {
        "basketAmount": 0,
        "downPaymentAmount": 0,
        "financedAmount": 0,
        "totalPayable": 0,
        "totalCostOfCredit": 0,
        "aprBasisPoints": 0,
        "instalments": [
          {
            "sequence": 0,
            "principalComponent": 0,
            "chargeComponent": 0,
            "amountDue": 0
          }
        ]
      },
      "specimenAtMaximum": {
        "basketAmount": 0,
        "downPaymentAmount": 0,
        "financedAmount": 0,
        "totalPayable": 0,
        "totalCostOfCredit": 0,
        "aprBasisPoints": 0,
        "instalments": [
          {
            "sequence": 0,
            "principalComponent": 0,
            "chargeComponent": 0,
            "amountDue": 0
          }
        ]
      }
    }
  ],
  "description": "Products retrieved successfully"
}

Responses

Status	When
`200`	Products retrieved successfully

GET Retrieve a product

GET /bnpl/product/{reference}

Includes a worked specimen schedule at the product's minimum and maximum amount, so the cost of credit and the equivalent annual rate are visible before publishing.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseProductResponse

curl -X GET "https://api.bridgemoni.com/bnpl/product/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "programmeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "scheduleKind": "EQUAL_SPLIT",
    "pricingKind": "FREE_TO_CUSTOMER",
    "regulatoryClass": "EXEMPT_DPC",
    "status": "DRAFT",
    "instalmentCount": 0,
    "periodLength": 0,
    "periodUnit": "DAY",
    "downPaymentBasis": "NONE",
    "downPaymentValue": 0,
    "rateBasisPoints": 0,
    "dayCountConvention": "ACT_365",
    "lateChargeKind": "NONE",
    "lateChargeValue": 0,
    "lateChargeCapBasis": 0,
    "graceDays": 0,
    "coolingOffHours": 0,
    "earlySettlementRebate": "PRO_RATA",
    "collateralKind": "NONE",
    "allocationOrder": "OLDEST_FIRST",
    "minAmount": 0,
    "maxAmount": 0,
    "affordabilityFactor": 0,
    "shariaBoardReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "shariaApprovedOn": "2026-09-25",
    "priceGrid": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "band": "NO_SCORE",
        "rateBasisPoints": 0,
        "limitCeiling": 0
      }
    ],
    "specimenAtMinimum": {
      "basketAmount": 0,
      "downPaymentAmount": 0,
      "financedAmount": 0,
      "totalPayable": 0,
      "totalCostOfCredit": 0,
      "aprBasisPoints": 0,
      "instalments": [
        {
          "sequence": 0,
          "principalComponent": 0,
          "chargeComponent": 0,
          "amountDue": 0
        }
      ]
    },
    "specimenAtMaximum": {
      "basketAmount": 0,
      "downPaymentAmount": 0,
      "financedAmount": 0,
      "totalPayable": 0,
      "totalCostOfCredit": 0,
      "aprBasisPoints": 0,
      "instalments": [
        {
          "sequence": 0,
          "principalComponent": 0,
          "chargeComponent": 0,
          "amountDue": 0
        }
      ]
    }
  },
  "description": "Product retrieved successfully"
}

Responses

Status	When
`200`	Product retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors