Customer Account Transaction (Customer Credit)

The customer account transaction endpoint enables the crediting of customer accounts. Credits granted via this endpoint are automatically applied to future orders by the customer (e.g. reducing the order total to pay by the amount of credit on the customer's account).

Background

This endpoint was funded by a project in the UK aimed at improving digital inclusion, which also involved the building of an integration linking POS payments with OFN customers. Customers made in-person payments via a POS device. The integration matched the email address entered on the POS device with an OFN customer record, and this endpoint was used to credit the customer's account with the amount paid.

Alternative uses for this endpoint include setting up a CSA payments system, i.e. customers pay X amount at the beginning of the season upfront, with subsequent orders deducted from their balance.

The UI can also be used to credit an account with the 'credit customer' button that displays when an order is in the 'credit owed' state, for instance by removing an item or creating a negative adjustment - see user guide.

Create customer transaction

post

Body

customer_idintegerRequiredExample: 10

amountdecimalRequiredExample: 10.5

descriptionstring · nullableOptionalExample: Payment processed by POS

Responses

201

Customer transaction created

application/json

metaobjectOptional

linksobjectOptional

401

Unauthorized

404

Invalid customer ID

application/json

422

Missing required parameter

application/json

post/api/v1/customer_account_transaction

POST /api/v1/customer_account_transaction HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "customer_id": 10,
  "amount": 10.5,
  "description": "Payment processed by POS"
}

{
  "data": {
    "id": "1",
    "type": "customer_account_transaction",
    "attributes": {
      "id": 1,
      "customer_id": 10,
      "amount": 10.5,
      "currency": "AUD",
      "description": "Payment processed by POS",
      "balance": 10.5
    },
    "relationships": {
      "customer": {
        "data": {
          "id": "text",
          "type": "customer"
        },
        "links": {
          "related": "text"
        }
      }
    }
  },
  "meta": {},
  "links": {}
}

Only managers or owners of an enterprise can credit customers

Customer ID can be obtained from the 'id' column in the Customers screen