Documentation/API Reference

API REFERENCE

Cancel a payment split

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Cancel a payment split

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters4

Required fields first

Cancel a payment split

commandRequiredstringdata.commandCancelSplitPayment
nonce_stringRequiredstringdata.nonce_stringRandom string, no longer than 32 characters
reference_idRequiredstringdata.reference_idMerchant's payment split ID, no longer than 32 characters
split_idRequiredstringdata.split_idPayment split order number generated when the payment split is created

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

This API cancels a YabandPay payment split order with the status Processing.

ParameterTypeDescriptionRequired
userStringUID of the super administrator accountRequired
signStringSignatureRequired
methodStringv3.SplitPaymentRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
commandStringCancelSplitPaymentRequired
nonce_stringStringRandom string, no longer than 32 charactersRequired
reference_idStringMerchant's payment split ID, no longer than 32 charactersRequired
split_idStringPayment split order number generated when the payment split is createdRequired

Signature example:

Sorted parameters concatenated into a URL-style query string

"command=cancelSplitPayment&method=v3.SplitPayment&nonce_string=0y9nydkzlmivuhs5xz&reference_id=123456&split_id=20231229110618372777&time=1703832252&user=9212776037"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
    "user": "9212776037",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.SplitPayment",
    "time": 1703832252,
    "data": {
        "command": "cancelSplitPayment",
        "nonce_string": "0y9nydkzlmivuhs5xz",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "split_id": "20231229110618372777",
        "reference_id": "123456",
        "state": "Cancelled"},
    "message": ""
}
  • Response parameters
ParameterTypeDescription
split_idStringPayment split order number generated when the payment split is created
stateStringStatus: Cancelled or Failed
reference_idStringMerchant's payment split ID, no longer than 32 characters
referenceStringDescription, no longer than 128 characters