Payment Method GET

URI

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

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

Description

This message allows you to retrieve payment methods by ID. If you don't specify an ID it will retrieve all available payment methods.

Detailed field description:

Field Name Field Description Required
name The "name" of the payment method. True
code The code for the payment method, max 32 char True
isActive Signals if the payment method is active True
bankAccounts List of bank accounts associated with the payment method True
currencyIsoCode The ISO code for the currency of the bank account True
bankAccountNominalCode The nominal code for the bank account True
installedIntegrationId the ID of the related integration channel, defaults to 0 if not provided. True

Example 1

Get the payment method with ID 1.

Request URI

/payment-method/1

Request body

{
}

Response

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

Example 2

Get all payment methods

Request URI

/payment-method/

Request body

{
}

Response

{
	"response": [
		{
			"name": "Sage Pay UK",
			"code": "SAGEPAY_UK",
			"isActive": true,
			"bankAccounts": [
				{
					"paymentMethodId": 1,
					"currencyIsoCode": "GBP",
					"bankAccountNominalCode": "1200"
				}
			],
			"installedIntegrationId": "1"
		},
		{
			"name": "Sage Pay US",
			"code": "SAGEPAY_US",
			"isActive": true,
			"bankAccounts": [
				{
					"paymentMethodId": 2,
					"currencyIsoCode": "USD",
					"bankAccountNominalCode": "1201"
				}
			],
			"installedIntegrationId": "1"
		}
	]
}