Save Payment

post https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/ordersets/{ordersetLookupId}/payments

Add or Update a Payment

Path Params

space

string

required

The name of the space (database) assigned to you.

ordersetLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

dim

string

The Dimensions under which the calling application operates.
Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

response

boolean

Defaults to false

If true, returns the saved content/resource. If false, the response content tag is not populated. Only set to true when the response payload is needed.

Body Params

orderId

string

length ≤ 15

NEON's internal Order Id. Accepts Lookup Id when saving

orderSetId

string

length ≤ 15

NEON's Order Set Id.

paymentId

string

length ≤ 15

NEON's internal Payment Id, unique within the Order Set. Leave blank when creating a new Payment. Case sensitive.

bizPaymentId

string

length ≤ 50

Optional business-specific Payment Id. Must be unique within the Order Set. Case sensitive.

state

string

required

NEON's internal Payment state, so that NEON can calculate order totals correctly

bizState

string

An optional free-text business-specific payment state.

paymentDate

date-time

Timestamp when the payment was made.
Defaults to when the payment was first saved to NEON but can be overridden.

currency

string

If the payment was made in a different currency to the order currency, then specify the payment currency here.
NOTE: Not yet supported.

currencyAmount

number

Only applicable if currency a specified. Holds the amount paid in the payment currency.
NOTE: Not yet supported.

amount

number

required

The payment amount, in the Order currency. This amount can be either positive or negative. Negative payment amounts are normally only used together with refunds.

reference

string

length ≤ 500

Optional free-text payment reference

data

json

Optional additional data in Json format

Response

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://neon-loyalty-qa.spika.com/loyalty/v1/space/ordersets/ordersetLookupId/payments?response=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"state":"DRAFT"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK