Payment Links

Update a payment link

Partially updates a payment link. Only the fields you send are changed.

patch/payment-links/{id}

Request

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

Request body

titlestring
amountstring

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

isReusableboolean
expiresAtstring date-time
customerIdstring
customerNamestring
customerPhonestring

A valid Iraqi phone number in E.164 form.

Example request

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

Response

Updated payment link

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.