Skip to main content
POST
/
merchant
/
invoice
/
external_gateway_invoice
/
mark_paid
Mark External Gateway Invoice As Paid
curl --request POST \
  --url https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalTransactionId": "<string>",
  "invoiceId": "<string>",
  "signature": "<string>",
  "timestamp": 123,
  "gatewayId": 123,
  "metadata": {},
  "paidTime": 123
}
'
{
  "code": 123,
  "data": {
    "invoiceId": "<string>",
    "paymentId": "<string>",
    "status": "<string>",
    "subscriptionId": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Mark invoice as paid. Auth: OpenAPI + signature (HMAC-SHA256 of invoiceId|externalTransactionId|timestamp with gateway API Key, hex).

externalTransactionId
string<string>
required

External payment transaction id from gateway, used as idempotent key

invoiceId
string<string>
required

Invoice id

signature
string<string>
required

HMAC-SHA256(gatewayKey, invoiceId|externalTransactionId|timestamp), hex-encoded

timestamp
integer<int64>
required

Request timestamp, UTC seconds, used for expiry check

gatewayId
integer<int64>

Optional. External gateway id; omit to use invoice's current gateway for auth

metadata
object

Additional metadata from external gateway

paidTime
integer<int64>

Paid time, UTC timestamp in seconds (optional, default now)

Response

200 - application/json
code
integer<int>
data
object
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>