Authorize resource access

Ask Recuut whether a client may receive a resource, such as an API response or digital item you sell. If payment is needed, Recuut returns HTTP 402 with instructions for the payer to retry.

POST/merchant/v1/access

Request

Header Parameters

PAYMENT-SIGNATURE?

Payment proof created by the payer. Forward this base64 text unchanged. Leave it out on the first request. Include the payer's exact value when it retries after HTTP 402. See the decoded fields.

Authentication

Authorization*Bearer <token>

Private API key for your Recuut account. A recuut_test_ key uses test payers and transactions. A recuut_live_ key uses live data. Send this key only from your server.

In: header

Request body

application/json

Resource details and reporting rules for one access check.

resource*AccessResource

Details of the resource your app plans to return after access is allowed.

Example

{  "description": "Generate a paid quarterly research report.",  "mime_type": "application/json",  "url": "https://merchant.example/reports/quarterly"}

description?

Optional description of what the payer receives.

mime_type*

Content type returned by the resource, such as application/json. Use lowercase type/subtype text without a charset or other parameters.

url*

Full HTTP or HTTPS URL of the resource. Do not include a username, password, query string, or # fragment.

revision_id*

ID of the published reporting rules for this resource. A published revision cannot change.

settlement_asset*

Settlement token selected by the published revision's Price.

Response

application/json

Headers

RECUUT-RESOURCE-EXECUTION-ID: Identifier for this allowed resource execution. New SDKs use it to report safe response metadata.

Schema

Successful access check; HTTP 200 means your app may return the resource.

transaction_id*|

Payment transaction ID, or null when access is free.

Example"txn_00000000000070008000000000000000"

Examplenull

Request example

curl --request POST \  --url "$RECUUT_API_URL/merchant/v1/access" \  --header "Authorization: Bearer $RECUUT_API_KEY" \  --header 'Content-Type: application/json' \  --data '{"resource":{"description":"Generate a paid quarterly research report.","mime_type":"application/json","url":"https://merchant.example/reports/quarterly"},"revision_id":"acr_00000000000070008000000000000000","settlement_asset":"USDC"}'

HTTP response examples

200 · OKapplication/json

Response headers

RECUUT-RESOURCE-EXECUTION-ID

HTTP 200 means the merchant may serve the resource without payment.

{  "transaction_id": null}