Herald
OpenapiBilling

Create_payment_attempt

POST
/api/bill/{realmId}/purchase/payment-attempts

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Path Parameters

realmId*string

Realm ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

metadata?unknown
openid?|

WeChat JSAPI payer openid; required when paymentScene = "jsapi".

paymentProvider*string
paymentScene?|

WeChat-only checkout scene: "native" (default) or "jsapi". Ignored by other providers (DEC-wechat-support-009).

targetId*string
Formatuuid
targetType*string

Response Body

application/json

curl -X POST "https://example.com/api/bill/string/purchase/payment-attempts" \  -H "Content-Type: application/json" \  -d '{    "paymentProvider": "string",    "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",    "targetType": "string"  }'
{  "amount": 0,  "createdAt": "string",  "currency": "string",  "expiresAt": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "paymentContext": {    "clientSecret": "string",    "creemCheckoutUrl": "string",    "stripeCheckoutUrl": "string",    "wechatCodeUrl": "string",    "wechatJsapiParams": null  },  "paymentProvider": "string",  "realmId": "string",  "status": "string",  "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",  "targetType": "string",  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"}
Empty
Empty
Empty
Empty