Create a credit grant

Creates a credit grant.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Credit grant payload

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Type of credit grant.

Value in"paid" | "promotional"

account_id*string

Account ID associated with the credit grant.

asset_code?string

Asset code of the credit grant. Required when currency is not set.

currency?string

Currency of the credit grant. Required when asset_code is not set.

Match^[A-Z]{3}$

grant_amount*integer

Granted amount in currency subunits or quantity of credit assets.

Range0 <= value

invoice_after_payment?boolean

Whether to create an invoice after payment. Defaults to true.

name?|

Name of the credit grant.

description?|

Description of the credit grant.

expires_at?|

Date when the credit grant expires.

Formatdate-time

initiate_payment?boolean

Initialize payment for the credit grant and return the providers payment URL.

integration_id?string

Integration ID for payment processing.

allowed_payment_methods?array<string>

Payment methods to show on the payment link.

return_url?string

URL to redirect after payment.

metadata?|

Key-value pairs that can be used to store additional information.

product_ids?array<string>

Catalog product IDs this grant applies to. Omit or empty for unrestricted (any product).

Response Body

`application/json`

curl -X POST "https://example.com/credit-grants" \  -H "Content-Type: application/json" \  -d '{    "type": "promotional",    "account_id": "acc_IhMUl3rrZ3",    "currency": "USD",    "grant_amount": 25000,    "invoice_after_payment": true,    "initiate_payment": true,    "integration_id": "int_IhMUl3rrZ3",    "allowed_payment_methods": [      "card",      "bank_transfer"    ],    "return_url": "https://northwind.example/checkout/return"  }'

{
  "credit_grant": {
    "object": "credit_grant",
    "id": "cgr_IhMUl3rrZ3",
    "type": "promotional",
    "account_id": "acc_IhMUl3rrZ3",
    "currency": "USD",
    "status": "granted",
    "payment_status": "comped",
    "grant_amount": 25000,
    "available_amount": 15000,
    "created_at": "2025-02-14T17:33:40.843Z",
    "effective_at": "2025-02-14T17:33:40.843Z",
    "expires_at": "2025-03-14T17:33:40.843Z"
  },
  "meta": {
    "request_id": "req_IhMUl3rrZ3"
  },
  "payment_url": "string"
}

Authorization

Request Body

Response Body

201application/json

`application/json`