Payment Links

Create a payment link

Creates a payment link and returns its full record, including payPageUrl — the shareable URL you send to the customer. Omit amount to create an open-amount link where the customer enters the amount at checkout.

post/payment-links

Request

  • Base URL: https://api.swiftpayiq.com/api/v1
  • URL: https://api.swiftpayiq.com/api/v1/payment-links
  • Auth: HTTP bearer

Request body

titlestring required

Short title shown to the customer on the checkout page.

amountstring

An amount in IQD (no decimals), serialized as an integer string to preserve precision.

isReusableboolean

If true, the link can be paid more than once. Default: single-use.

expiresAtstring date-time

Optional expiry. ISO-8601 (YYYY-MM-DD or full timestamp).

customerIdstring

Optional existing customer id.

customerNamestring
customerPhonestring

A valid Iraqi phone number in E.164 form.

Example request

{
  "amount": "50000",
  "customerPhone": "+9647801234567"
}

Response

Payment link created

idstring
titlestring
slugstring
payPageUrlstring

Full shareable checkout URL — send this to the customer.

isLiveboolean
status'ACTIVE' | 'DISABLED' | 'EXPIRED'
isReusableboolean
amountstring

An amount in IQD (no decimals), serialized as an integer string to preserve precision.

feeRatestring

Gateway fee rate snapshot, as a percentage with up to 5 decimals.

feeAmountstring

An amount in IQD (no decimals), serialized as an integer string to preserve precision.

customerFeeSharestring

Fraction of the fee the customer paid (0..1).

netAmountstring

An amount in IQD (no decimals), serialized as an integer string to preserve precision.

expiresAtstring date-time nullable
customerIdstring nullable
customerNamestring nullable
customerPhonestring nullable
createdByTypestring

Actor that created the link.

sentAtstring date-time nullable
lastSentAtstring date-time nullable
sendCountinteger
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "payPageUrl": "https://swiftpayiq.com/pay?slug=xa7fi5brv1",
  "amount": "50000",
  "feeRate": "0.60325",
  "feeAmount": "50000",
  "customerFeeShare": "0.5000",
  "netAmount": "50000",
  "createdByType": "API_KEY",
  "payments": [
    {
      "provider": "ALQASEH",
      "amount": "50000",
      "feeAmount": "50000",
      "netAmount": "50000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.