Invoices

Confirm invoice payment

POST/v1/billing/invoices/{id}/confirm-payment

Confirms a payment the caller completed with the payment provider and records it on the invoice.

curl --request POST \
  --url https://api.serverside.com/v1/billing/invoices/{id}/confirm-payment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "providerTransactionId": "<string>",
  "providerType": "STRIPE"
}
'

{
  "success": true,
  "data": {
    "status": "PENDING",
    "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "clientSecret": "<string>",
    "declineCode": "UNKNOWN"
  }
}

Autorisatie

Authorizationstringheaderverplicht
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Vereiste toestemming: organization.billing.pay

Padparameters

idstring<uuid>verplicht

Body

application/json

providerTransactionIdstringverplicht
Grenzen:length >= 1
providerTypeenum<string>verplicht
Toegestane waarden:STRIPEMANUALACCOUNT_CREDIT

Antwoord

200 · application/json

OK

successbooleanverplicht
Toegestane waarden:true
dataobject | nullverplicht