Branch Getaway Partner API

Current live Pay-in / Pay-out integration contract

Base URLhttps://branchgetaway.com/api

AuthenticationPrivateKey header

Generated IDsOrder ID: 12 alphanumeric / Transaction ID: 12 numeric

Download live PDF

Integration summary

• Authentication: PrivateKey: YOUR_API_KEY

• Content-Type: application/json

• All API amounts are in INR. Send 100 for INR 100, 200 for INR 200, and 6767 for INR 6,767.

• Branch Getaway generates a 12-character uppercase alphanumeric Order ID and a separate 12-digit numeric Gateway Transaction ID.

• The partner TransactionId/transactionID is accepted as ClientTransactionId for reconciliation and status lookup.

Pay-in request

POSThttps://branchgetaway.com/api/payment/request

Request / headers

PrivateKey: YOUR_API_KEY
Content-Type: application/json

{
  "Amount": 100,
  "TransactionId": "PARTNER-UNIQUE-REFERENCE",
  "ClientUsername": "username",
  "ClientCode": "CC",
  "Description": "Deposit",
  "Email": "user@example.com",
  "MobileNo": "9876543210",
  "ReturnUrl": "https://partner.example/return",
  "Udf1": "", "Udf2": "", "Udf3": "", "Udf4": ""
}

Response

{
  "Url": "https://branchgetaway.com/pay/A7K9P2M4Q8X6",
  "OrderId": "A7K9P2M4Q8X6",
  "TransactionId": "583817204691",
  "ClientTransactionId": "PARTNER-UNIQUE-REFERENCE",
  "Status": {"returnMessage": "", "code": 0}
}

Pay-in status

GEThttps://branchgetaway.com/api/payment/status?TransactionId=PARTNER_OR_GATEWAY_ID

Request / headers

PrivateKey: YOUR_API_KEY
Content-Type: application/json

Response

{
  "Result": {
    "TransactionId": "583817204691",
    "ClientTransactionId": "PARTNER-UNIQUE-REFERENCE",
    "Description": "Deposit",
    "Amount": 100,
    "OrderId": "A7K9P2M4Q8X6",
    "ClientCode": "CC",
    "IsSuccess": false,
    "PaymentMode": "UPI",
    "StatusCode": 4,
    "Status": "Pending",
    "Utr": ""
  },
  "Status": {"returnMessage": "", "code": 0}
}

Pay-in multiple status

POSThttps://branchgetaway.com/api/payment/multipletransactionstatus

Request / headers

{
  "TransactionId": ["PARTNER-REF-1", "A7K9P2M4Q8X6"]
}

Response

Returns Result array with the same Pay-in status object for each ID. Maximum 100 IDs per request.

Pay-out request

POSThttps://branchgetaway.com/api/payout/request

• For Pay-out, name is the beneficiary bank Account Holder Name.

• For Pay-out, udf1 is the customer/site User ID shown separately in the Admin and Branch panels.

• Email and mobile number are not required for Pay-out.

Request / headers

PrivateKey: YOUR_API_KEY
Content-Type: application/json

{
  "accountNumber": "1012700000000",
  "ifsc": "IDFB0012345",
  "bankName": "State Bank Of India",
  "amount": 100,
  "name": "BENEFICIARY ACCOUNT HOLDER NAME",
  "transactionID": "PARTNER-UNIQUE-REFERENCE",
  "udf1": "ACTUAL-SITE-USER-ID",
  "udf2": "", "udf3": "", "udf4": ""
}

Response

{
  "transactionStatus": "INITIATED",
  "message": "",
  "orderId": "B6D9K2P7M4X8",
  "transactionID": "704193826551",
  "clientTransactionID": "PARTNER-UNIQUE-REFERENCE",
  "code": "SUCCESS"
}

Pay-out status

POSThttps://branchgetaway.com/api/payout/status

Request / headers

{
  "transactionID": "PARTNER_OR_GATEWAY_ID"
}

Response

{
  "transactionID": "704193826551",
  "clientTransactionID": "PARTNER-UNIQUE-REFERENCE",
  "transactionStatus": "PENDING",
  "amount": 100,
  "message": "Transaction pending",
  "utr": "",
  "orderId": "B6D9K2P7M4X8",
  "code": "SUCCESS"
}

Pay-out multiple status

POSThttps://branchgetaway.com/api/payout/multistatus

Request / headers

{
  "transactionID": ["PARTNER-REF-1", "B6D9K2P7M4X8"]
}

Response

Returns an array containing the same Pay-out status object for each ID. Maximum 100 IDs per request.

Pay-out balance

GEThttps://branchgetaway.com/api/payout/balance

Request / headers

PrivateKey: YOUR_API_KEY

Response

{
  "balance": 112750,
  "message": "Balance fetched successfully",
  "code": "SUCCESS"
}

Webhook callbacks

• Configure the Pay-in and Pay-out webhook URLs in the Partner settings or API key settings.

• Branch Getaway sends POST JSON with the PrivateKey header after Admin/Branch changes a request status.

• Pay-in webhook fields: TransactionId, ClientTransactionId, Description, ResMessage, GatewayName, Amount, Order_Id, ClientCode, IsSuccess, PaymentMode, Status, StatusCode, Utr.

• Pay-out webhook fields: transactionID, clientTransactionID, transactionStatus, amount, message, utr, orderId, code.

• Partner success acknowledgement: {"returnMessage":"Received","code":0} or {"message":"Received","code":"SUCCESS"}.

Status and response codes

• Pay-in API response code: Success=0, Warning=1, Error=2, Info=3.

• Pay-in status: Success=1, Failed=2, Cancelled=3, Pending=4, Incomplete=11, Invalid=14, TransactionNotFound=15, ProviderCreated=200.

• Pay-out status: INITIATED, PENDING, DONE, FAIL, FAILED, TransactionNotFound.

• HTTP: 400 invalid request, 401 invalid PrivateKey, 404 transaction not found, 409 duplicate/unavailable route, 500 backend error.