UpdatePaymentSettings

PATCH

https://api.upbooks.io/api/v1/organization/{id}/settings/payments

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Body Params application/json

enabled

boolean

required

gateway

object

optional

razorpay

object

optional

Example

{
    "enabled": true,
    "gateway": {
        "razorpay": {
            "fee": {
                "settlement": {
                    "value": 0,
                    "feeType": "flat"
                },
                "transaction": {
                    "value": 0,
                    "feeType": "flat"
                }
            },
            "account": {
                "bankAccount": {
                    "accountNumber": "string",
                    "accountType": "string",
                    "beneficiaryName": "string",
                    "ifscCode": "string"
                },
                "accountDetails": {
                    "businessType": "string",
                    "businessName": "string"
                },
                "tncAcceptedIPAdress": "string",
                "tncAcceptedAt": "2019-08-24T14:15:22Z",
                "tncAccepted": true,
                "email": "string",
                "name": "string",
                "rzpLinkedAccountId": "string"
            },
            "mode": "self",
            "enabled": true
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.upbooks.io/api/v1/organization//settings/payments' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enabled": true,
    "gateway": {
        "razorpay": {
            "fee": {
                "settlement": {
                    "value": 0,
                    "feeType": "flat"
                },
                "transaction": {
                    "value": 0,
                    "feeType": "flat"
                }
            },
            "account": {
                "bankAccount": {
                    "accountNumber": "string",
                    "accountType": "string",
                    "beneficiaryName": "string",
                    "ifscCode": "string"
                },
                "accountDetails": {
                    "businessType": "string",
                    "businessName": "string"
                },
                "tncAcceptedIPAdress": "string",
                "tncAcceptedAt": "2019-08-24T14:15:22Z",
                "tncAccepted": true,
                "email": "string",
                "name": "string",
                "rzpLinkedAccountId": "string"
            },
            "mode": "self",
            "enabled": true
        }
    }
}'

Responses

🟢200Ok

application/json

Body

data

object (OrganizationDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

name

string

required

organizationId

string

required

location

string

required

state

string

required

logo

string | null

optional

regionalSetting

object (IRegionalSetting)

required

taxSettings

array[object (IOrgTaxSettings) {3}] | null

optional

userId

string

required

settings

object (IOrganizationSettings)

required

fromEmail

string

optional

fiscalYear

object

optional

businessSettings

object | null

optional

isDeactivated

boolean

optional

platformCredits

object (IOrganizationPlatformCredits)

optional

registrationSource

enum<string>

optional

Allowed values:

upbooks-webupbooks-android-appupbooks-ios-appupbooks-expense-webupbooks-expense-android-appupbooks-expense-ios-app

organizationType

enum<string>

optional

Allowed values:

individualbusiness

phone

object (IPhone)

optional

message

string

optional

Example

🟢200Success

Modified at 2024-04-09 12:07:33

GetOrganizationPreferences

UpdateDefaultPaymentSettings