Skip to main content
POST
/
api
/
transactions
curl --request POST \
  --url https://sbx.api.easybilling.cloud/payment-hub/api/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactionId": "Order-123",
  "description": "Order-123 Payment",
  "amount": "123.00",
  "currency": "USD",
  "paymentGatewayType": "stripe-connect",
  "customerIdentifier": "customer@test.com",
  "onlineScenario": true,
  "completePayRedirectUrl": "https://example.com/payment/success",
  "cancelPayRedirectUrl": "https://example.com/payment/cancel"
}
'
{
  "paymentUrl": "<string>",
  "paymentId": "<string>",
  "expireTime": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
​
trace-id
string
default:{{$string.uuid}}

Body

application/json
​
transactionId
string
required

The business transaction id corresponding to the payment, such as order number，the length is less than or equal to 36 bits

Maximum string length: 32
​
amount
string
required
​
currency
string
required

ISO 4217 standard

​
customerIdentifier
string
required

Customer unique identifier, which can be phone number/email/UUID, etc. When using Stripe payment, this value must be an email

​
paymentGatewayType
enum<string>
required

stripe-connect (Stripe), payer-max-isv(PayerMax)

Available options:
stripe-connect,
payer-max-isv,
alipay-page,
wechat-pay-native
​
onlineScenario
boolean
required

True for instant payment, false for recurring payment

​
completePayRedirectUrl
string
required

Both successful and failed payments are considered completed. When the payment gateway is Stripe, this field is required and must start with https

​
cancelPayRedirectUrl
string
required

When the payment gateway is Stripe, this field is required and must be a URL starting with https

​
description
string

Description of the business transaction

​
supportOfflineScenario
boolean

when onlineScenario is true and set supportOfflineScenario to true, it is to support recurring auto payment, i.e. next time with onlineScenario false, payment will be collected successfully.

Response

200 - application/json
​
paymentUrl
string
required

Stripe, PayerMax can directly navigate to the payment page via this URL

​
paymentId
string
required

Unique ID generated when initiating payment

​
expireTime
integer
required

Payment timeout duration (in seconds)

​
status
enum<string>
required

Payment status

Available options:
waiting,
processing,
succeeded,
failed,
closed