Payment Method POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/accounting-service/payment-method/

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

Some things to consider:

  • Name and Code must be unique. They are case insensitive
  • Code will be converted to uppercase letters
  • Bank accounts are optional. If any bank accounts are specified, then one of them must be for the base currency
  • The bank account must exist in the chart of accounts
  • The currency ISO code must be setup in Brightpearl
  • The installed integration ID defaults to 0 if not provided

Example

Request URI

/payment-method/

Request body

{
	"name": "Sage Pay UK",
	"code": "SAGEPAY_UK",
	"isActive": true,
	"bankAccounts": [
		{
			"currencyIsoCode": "GBP",
			"bankAccountNominalCode": "1200"
		}
	],
	"installedIntegrationId": "1"
}

Response

{
	"response": 1
}