RESTB2BManagementPayments

Update Offline Payment

Update 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](/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. |

Path parameters

paymentIdstringRequired

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 is the same as the customerId.
processingStatusenumOptional
Allowed values:
fundingStatusenumOptional
Allowed values:

Response

OK
codedouble
dataobject
metaobject

Errors

422
Unprocessable Entity Error