/payment-setting/
This endpoint is responsible for creating a new payment setting.
Method:
POST
Request Payload:
Field | Type | Required | Description |
---|---|---|---|
name | string | Yes | The name of the payment setting |
type | string | Yes | The type of the payment setting |
settings | object | Yes | The settings/configuration of the payment setting. Some of the sample properties are āaccountNameā, āaccountNumberā, ābankNameā, āroutingNumberā, āswiftCodeā, āIBANā, indicating details related to the payment method configuration |
isDefault | boolean | No | Indicates whether the payment setting is the default one |
memo | string | No | Any additional notes or comments about the payment setting |
Bank Wire Transfer:
{
"name": "Primary Bank Account",
"type": "BankWireTransfer",
"settings": {
"bankName": "Bank of Example",
"accountNumber": "123456789",
"bankCode": "987654",
"country": "USA",
"countryCode": "US",
"currency": "USD"
},
"isDefault": true,
"memo": "Main operational account"
}
PayPal:
{
"name": "Primary PayPal Account",
"type": "PayPal",
"settings": {
"paypalEmail": "example@paypal.com",
"country": "USA",
"countryCode": "US",
"currency": "USD"
},
"isDefault": true,
"memo": "Main PayPal account"
}
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Payment setting created successfully
The response is of type object
.