Create Offline Payment | BigCommerce Developer Center

Create offline payment

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Request

This endpoint expects an object.

lineItemslist of objectsRequired

currencystringRequired

detailsobjectRequired

customerIdstringRequired

B2B Edition Company ID

externalIdstringOptional

externalCustomerIdstringOptional

payerNamestringOptionalDefaults to Store offline payment

Default is "Store Offline Payment " if no value is passed in.

payerCustomerIdstringOptional

The default value is the same as the customerId.

processingStatusenumOptional

payment status, 3 is the default

Allowed values:

channelIdintegerOptional

BigCommerce channel ID

Response

codedouble

dataobject

metaobject

Errors

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/ip/payments/offline"
4
5	payload = {
6	"lineItems": [
7	{
8	"invoiceId": 13,
9	"amount": "20.00"
10	}
11	],
12	"currency": "USD",
13	"details": { "memo": "Test" },
14	"customerId": "113",
15	"payerName": "Store offline payment",
16	"payerCustomerId": "113",
17	"processingStatus": 3,
18	"fundingStatus": "2"
19	}
20	headers = {
21	"X-Auth-Token": "<apiKey>",
22	"Content-Type": "application/json"
23	}
24
25	response = requests.post(url, json=payload, headers=headers)
26
27	print(response.json())

1	{
2	"code": 200,
3	"data": {
4	"paymentId": 112
5	},
6	"meta": {
7	"message": "SUCCESS"
8	}
9	}