Initiate a refund

Refund a collection back to its original sender. Blaaiz refunds the full collection amount only; there is no amount field.

The collection must belong to one of your business customers, be created through the API, and be a successful EUR or GBP ClearJunction collection. The refund must start within 7 days of the collection. Only one refund attempt is allowed per collection.

Pass an optional reference as an idempotency key: reusing the same reference on the same transaction_id returns the same refund instead of creating a second one. Required scope: refund:create.

POSTapi-prod.blaaiz.com/api/external/refund

Authorization

oauth2ClientCredentials refund:create

AuthorizationBearer <token>

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

In: header

Scope: refund:create

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transaction_id*string

The transaction ID of the collection to refund. The collection must belong to one of your business customers, be created through the API, and be a successful EUR or GBP ClearJunction collection.

reason?string

Optional reason for the refund. Stored against the transaction. Defaults to Refund of collection to source when omitted.

Lengthlength <= 250

reference?string

Optional idempotency key of your choice. Reuse the same reference on the same transaction_id to safely retry without a second refund. The same reference on a different transaction returns a 400 conflict.

Lengthlength <= 100

Response Body

`application/json`

Initiate a refund

curl --request POST \  --url 'https://example.com/api/external/refund' \  --header 'Content-Type: application/json' \  --data '{  "transaction_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee"}'

{  "message": "Refund initiated successfully.",  "data": {    "id": "a1f7c9e2-4b3d-4c8a-9f2e-7d6b5a4c3e21",    "status": "PROCESSING",    "type": "FULL",    "amount": 500,    "currency": "GBP",    "transaction_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",    "reference": "refund-order-8842",    "business_customer_id": "6c258e65-de94-4d9d-87fb-117480a9d0e7",    "refund_reference": "cj-refund-3f9a12",    "failure_reason": null,    "created_at": "2026-08-03T10:15:00.000000Z",    "updated_at": "2026-08-03T10:15:02.000000Z"  }}