Invoices

Confirm invoice payment

POST/v1/billing/invoices/{id}/pay/confirm

curl --request POST \
  --url https://api.serverside.com/v1/billing/invoices/{id}/pay/confirm \
  --header 'X-API-KEY: <api-key>'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "success": true,
    "errorMessage": "<string>",
    "transactionReferenceId": "<string>",
    "clientSecret": "<string>",
    "status": "PENDING",
    "providerErrorCode": "<string>",
    "isPermanentDecline": true,
    "isImmediateSuccess": true,
    "isPending": true
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-KEYstringheaderrequired
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Path parameters

idstring<uuid>required

Query parameters

provider_transaction_idstring
provider_typeenum<string>
Allowed values:STRIPEMANUALACCOUNT_CREDIT

Response

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject