Create Copyright Wallet Top-Up

Create a checkout to add credits to the copyright wallet. Store checkout_id and verify the top-up before assuming new credits are available.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Request payload.

TypeScript Definitions

Use the request body type in TypeScript.

currency*string

ISO currency code for the amount shown on the same object.

package_code*string

PACKAGE CODE code used for catalog, country, currency, or rights metadata.

success_url*string

Public URL returned for this resource or action.

Formaturi

cancel_url*string

Public URL returned for this resource or action.

Formaturi

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/copyright/wallet/top-up" \  -H "Content-Type: application/json" \  -d '{    "currency": "GBP",    "package_code": "copyright_100",    "success_url": "https://northstar-distribution.co.uk/copyright/top-up/success",    "cancel_url": "https://northstar-distribution.co.uk/copyright/top-up/cancel"  }'

{  "success": true,  "message": "Checkout created.",  "data": {    "top_up_id": "2b8a0b6b-bca0-4b7f-8049-672e9a9d2928",    "checkout_id": "39b189c1-8f8e-4df2-8632-176f87f791a1",    "status": "pending",    "quote": {      "credits": 100,      "amount": 25,      "currency": "GBP"    },    "checkout": {      "checkout_id": "39b189c1-8f8e-4df2-8632-176f87f791a1",      "gateway": "airwallex",      "status": "pending",      "redirect_url": "https://checkout.spacemedia-docs.invalid/session/docs-checkout-session",      "embedded_checkout_token": "docs_invalid_embedded_checkout_token",      "amount": 49,      "currency": "GBP",      "expires_at": "2026-07-04T10:30:00+00:00"    }  }}

Authorization

Request Body

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`