Add money to a Wallet with checkout link

Generate a checkout link to add money for the wallet.

post

Query parameters

currencyCodestringRequired

The currency code. The currency code must be a valid ISO 4217 currency code.

amountnumber · doubleRequired

The amount to add. The amount must be greater than 0.

returnLinkstring · uriRequired

The return link after the payment is successful.

cancelLinkstring · uriRequired

The cancel link after the payment is canceled.

testModebooleanOptional

The test mode. By default, it is false.

Default: false

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

datastring · nullableRead-onlyOptional

This is the data to be returned to the client.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/wallets/add-money/checkout-link

HTTPcURLJavaScriptPython

POST /api/v1/wallets/add-money/checkout-link?currencyCode=text&amount=1&returnLink=https%3A%2F%2Fexample.com&cancelLink=https%3A%2F%2Fexample.com HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "https://example.com/checkout",
  "errors": []
}