C1c1st
PaymentTypeRelations

Changes status of a payment

Can only change the status of a payment if it is not captured

put/paymenttyperelation/{paymentId}

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/paymenttyperelation/{paymentId}
  • Auth
    HTTP bearer

Request body

idinteger nullable
titlestring

The title of the payment. E.g. 'cash' or 'Dankort'

paymenttypeidinteger nullable

reference to user created payment type.

amountnumber double

The amount of the payment type.

unroundedcashnumber double nullable

The unrounded amount for a cash payment. Used to calculate rounding difference

cashinteger

Returns whether or not the payment type is cash-based.

bamdesk_messageidinteger nullable

If provider = 'bamdesk'. This will be the id for the messageid for Worldline card-terminal.

accountnostring nullable

The account where the payment has been posted. If not applicable, it will be null.

currencystring nullable

3-digit currency code if the payment is in foreign currency.

exchangeratenumber double nullable

The exchange rate if the payment is in foreign currency

receiptsstring[] nullable

Index for where it's stored.

receiptsCountinteger nullable

Number of entries in receipts.

mobilepayidstring nullable

If provider = 'mobilepay' this is a reference to the Mobile Pay transaction

paymentidinteger nullable

The paymentid the type is related to

vipps_reference_idstring nullable

The reference for the vipps payment

adyen_reference_idstring nullable

The reference for the adyen payment

error_messagestring nullable

If an error occured during the payment, this will contain the error message, if supported by the provider.

status'initiated' | 'reserved' | 'cancelled' | 'captured'
initiated_amountnumber double nullable

The amount attempted when the payment type was initiated. Defaults to amount when omitted on creation.

created_atstring nullable

The timestamp for when the payment type relation was created.

updated_atstring nullable

The timestamp for when the payment type relation was last updated.

Example request

{
  "title": "Cash",
  "amount": 123.45,
  "unroundedcash": 123,
  "bamdesk_messageid": 4343,
  "accountno": "1234",
  "currency": "DKK"
}

Response

Ok

idinteger nullable
titlestring

The title of the payment. E.g. 'cash' or 'Dankort'

paymenttypeidinteger nullable

reference to user created payment type.

amountnumber double

The amount of the payment type.

unroundedcashnumber double nullable

The unrounded amount for a cash payment. Used to calculate rounding difference

cashinteger

Returns whether or not the payment type is cash-based.

bamdesk_messageidinteger nullable

If provider = 'bamdesk'. This will be the id for the messageid for Worldline card-terminal.

accountnostring nullable

The account where the payment has been posted. If not applicable, it will be null.

currencystring nullable

3-digit currency code if the payment is in foreign currency.

exchangeratenumber double nullable

The exchange rate if the payment is in foreign currency

receiptsstring[] nullable

Index for where it's stored.

receiptsCountinteger nullable

Number of entries in receipts.

mobilepayidstring nullable

If provider = 'mobilepay' this is a reference to the Mobile Pay transaction

paymentidinteger nullable

The paymentid the type is related to

vipps_reference_idstring nullable

The reference for the vipps payment

adyen_reference_idstring nullable

The reference for the adyen payment

error_messagestring nullable

If an error occured during the payment, this will contain the error message, if supported by the provider.

status'initiated' | 'reserved' | 'cancelled' | 'captured'
initiated_amountnumber double nullable

The amount attempted when the payment type was initiated. Defaults to amount when omitted on creation.

created_atstring nullable

The timestamp for when the payment type relation was created.

updated_atstring nullable

The timestamp for when the payment type relation was last updated.

Example response

{
  "title": "Cash",
  "amount": 123.45,
  "unroundedcash": 123,
  "bamdesk_messageid": 4343,
  "accountno": "1234",
  "currency": "DKK"
}

Changes

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