TruBit Business
πŸ‡ΊπŸ‡Έ EN 2025/05/08
πŸ‡ΊπŸ‡Έ EN 2025/05/08
  • πŸ“– Guides
    • A Gentle Introduction
    • Step-by-Step Guide
    • Creating TruBit Account
    • Creating API Key
      • Safely Store Your API Key
      • Configure Whitelisted IPs
      • Enable API Access
      • Create API Token
    • Sandbox
    • Creating Your Merchant
    • Creating Payment Method
    • Payment Method ID
    • Currencies
    • Pair
    • Creating Webhook Listener
    • Fiat to Crypto (On-Ramp)
    • Crypto to Fiat (Off-Ramp)
    • Fiat to Fiat (Global Payment)
  • πŸ“— API Reference
    • Basic Configuration
      • API Endpoint
      • Get List of Countries
      • Get List of Fiat Currencies
      • Get List of Crypto Currencies
      • Get Fiat/Crypto Pairs
      • Get Crypto/Fiat Pairs
      • Get Fiat/Fiat Pairs
      • Get Fiat/Crypto Payment Methods
      • Get Crypto/Fiat Payment Methods
      • Get Fiat/Fiat Payment Methods
    • Account
      • Get Account Details
      • Get Crypto Assets Balance
      • Get Crypto Deposit Address
    • Merchant
      • Add Merchant
      • Get a List of Merchants
      • Get a List of Merchant Accounts
      • Retrieve Pending Fund
      • Claim Pending Fund
      • Get Transfer Pending Funds Fee
      • Transfer Pending Funds
      • Retrieve Funding Records
    • Quote
      • Get User Quote for Crypto/Fiat
      • Get User Quote for Fiat/Fiat
    • Payment Method
      • Get Payment Templates
      • Add Payment Method
      • Get Payment Method
      • Delete Payment Method
      • Set Refund Account
    • Order
      • Create a Fiat to Crypto Order
      • Create a Crypto to Fiat Order
      • Create a Fiat to Fiat Order
      • Confirm a Specific Order
      • Retrieve a Specific Order
      • Retrieve a List of Orders
      • Upload Invoice Documents For a Specific Order
    • Webhooks
      • Create Webhook Endpoints
      • Get Webhook Endpoints
      • Update a Webhook
      • Delete a Webhook
      • Fiat/Crypto Order Message Push
      • Fiat/Fiat Order Message Push
      • Funding Records Message Push
  • πŸ› οΈ Error Reference
    • Error and Warning Dictionary
  • πŸͺ„Changelog
    • πŸ••Changelog
Powered by GitBook
On this page
  1. πŸ“— API Reference
  2. Payment Method

Set Refund Account

This API allows you to set a refund account for a specific payment method.

Endpoint Information

  • Request Header: X-BH-TOKEN: ******

  • Request Header: Content-Type: application/json

  • Request Method: POST

  • Request Path: /openapi/v2/payment/refund_account

  • Authorization Required: Yes

Request Body Parameters

The request body should include the following fields:

{
  "userPaymentId": 0,  (int) The ID of the user payment method.
  "merchantId": 0 (int) The ID of the merchant id.
}

Request Body Parameters

The request body should include the following fields:

{
  "userPaymentId": 2,         // (number: The ID of the user payment method)
  "merchantId": 6          // (number: The ID of the merchant id)  
}

Authorization

This request requires authorization.

Response Structure

The response will include the following fields:

{
    "code": 200,                        // (number: response code)
    "msg": "SUCCESS",                   // (string: message)
    "data": true                        // (boolean: indicates if the operation was successful)
}

Example Request

To set a refund account for a payment method with userPaymentId of 123 and settingsId of 456:

Example Request

{
  "merchantId": 456,
  "userPaymentId": 123 
}

Example Response

{
    "code": 200,
    "msg": "SUCCESS",
    "data": true
}

Notes

  • Ensure that valid authorization tokens are included in the request headers for successful execution.

  • Confirm that the specified userPaymentId and settingsId are valid and that the payment method is eligible for setting a refund account.

PreviousDelete Payment MethodNextOrder