Get a payment

Production

https://api.belga.press/belgapress/api

GET

/payments/{paymentId}

Returns the current state of a Payment. The front-end polls this after the embedded payment completes, until status is terminal. This endpoint, not the client return URL, is the authoritative outcome.

Terminal states the front-end visualises: - succeeded -> paid AND the press release was published (invoice sent). Show
"continue to your published press release".

failed -> the payment did not go through (declined, abandoned, SCA failed).
Show a failure screen with a retry that creates a new payment.

refunded -> paid, but the publish failed server-side, so the payment was
automatically refunded. Show a "could not publish, you have been refunded"
state.

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://sso.ssl.belga.be/auth/realms/belga/protocol/openid-connect/auth

Token URL: https://sso.ssl.belga.be/auth/realms/belga/protocol/openid-connect/token

Scopes:

offline_access-Offline access

openid-OpenID

profile-Profile

email-Email

Path Params

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.belga.press/belgapress/api/payments/' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "id": "pay_3Nf1Qe2eZvKYlo2C",
    "resourceType": "press_release",
    "resourceId": "7b2c1e90-9c1a-4f3e-bf2a-2f5d9a0c1d34",
    "status": "pending",
    "amount": {
        "amount": 49500,
        "currency": "EUR"
    },
    "clientSecret": "cs_test_a1b2c3_secret_x9y8z7",
    "paymentMethodTypes": [
        "card",
        "bancontact"
    ],
    "invoiceSent": false,
    "refundId": "string",
    "failureReason": "string",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-06-26 11:02:50

Create an embedded Stripe payment for a resource

Stripe webhook (server-to-server)