Payments

Upsert Payment

put/v1/transactions/payments/{payment_id}

Request

  • Base URL: https://api.blueonion.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.blueonion.ai/v1/transactions/payments/{payment_id}
  • Auth: HTTP bearer

Path parameters

payment_idstring required

Request body

payment_idstring required

External payment id (OrderTransaction.id).

order_reference_idstring required

Order this payment applies to; must reference an existing order.

processed_atstring date-time required

When the payment was processed (OrderTransaction.processedAt).

payment_typestring required

Transaction kind: sale | refund | capture | authorization | void | return.

gatewaystring required

Payment gateway: stripe | gift_card | manual | cash | ...

currencystring required

ISO 4217 currency code; auto-uppercased.

amountnumber required

Signed amount; negative for refund/return.

purchase_amountnumber nullable

Presentment (purchase) amount.

purchase_currencystring nullable

Presentment ISO 4217 currency; auto-uppercased.

statusstring

Transaction status (OrderTransaction.status).

feesnumber nullable

Processor fees on the payment.

net_amountnumber nullable

Net amount after fees.

payout_idstring nullable

Settlement/payout id.

binstring nullable

Card BIN (OrderTransaction.paymentDetails.bin).

parent_payment_idstring nullable

Parent payment id for captures/refunds (OrderTransaction.parentTransaction).

edit_versioninteger nullable

Order edit version.

authorized_atstring date-time nullable

Authorization timestamp.

available_atstring date-time nullable

Funds-available timestamp.

paid_out_atstring date-time nullable

Payout timestamp.

Response

Successful Response

transaction_idstring required
actionstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.