GET api/Contact/{handle}/Credit?transactionId={transactionId}&date_transaction={date_transaction}&user={user}

Return a list of credit operations

Request Information

URI Parameters

NameDescriptionTypeAdditional information
handle

The facturation handle

string

Required

transactionId

Optional - the transaction id of a credit operation

string

None.

date_transaction

Optional - returns credit operations with a transaction date greater than

date

None.

user

Optional user handle - if empty logged in user will be used

string

None.

Body Parameters

None.

Response Information

Resource Description

A list of credit operations on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Collection of Credit
NameDescriptionTypeAdditional information
TransactionID

Transaction id

string

None.

Total

Total credit - in euros

decimal number

None.

Currency

Currency

string

None.

CurrencyCoefficient

Currecny coefficient

decimal number

None.

Status

Operation status
0 - PENDING_PAYMENT
1 - PENDING_VALIDATION
2 - VALIDATED
3 - FAILED
4 - BANK_CANCELED
7 - CANCELED

byte

None.

CardType

Card type

string

None.

PaymentMode

Payment Mode

string

None.

Refund

Is a refund

boolean

None.

DateTransaction

Transaction date

date

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TransactionID": "sample string 1",
    "Total": 2.0,
    "Currency": "sample string 3",
    "CurrencyCoefficient": 4.0,
    "Status": 64,
    "CardType": "sample string 5",
    "PaymentMode": "sample string 6",
    "Refund": true,
    "DateTransaction": "2026-11-04T07:23:11.0107687+01:00",
    "Description": "sample string 9"
  },
  {
    "TransactionID": "sample string 1",
    "Total": 2.0,
    "Currency": "sample string 3",
    "CurrencyCoefficient": 4.0,
    "Status": 64,
    "CardType": "sample string 5",
    "PaymentMode": "sample string 6",
    "Refund": true,
    "DateTransaction": "2026-11-04T07:23:11.0107687+01:00",
    "Description": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCredit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">
  <Credit>
    <CardType>sample string 5</CardType>
    <Currency>sample string 3</Currency>
    <CurrencyCoefficient>4</CurrencyCoefficient>
    <DateTransaction>2026-11-04T07:23:11.0107687+01:00</DateTransaction>
    <Description>sample string 9</Description>
    <PaymentMode>sample string 6</PaymentMode>
    <Refund>true</Refund>
    <Status>64</Status>
    <Total>2</Total>
    <TransactionID>sample string 1</TransactionID>
  </Credit>
  <Credit>
    <CardType>sample string 5</CardType>
    <Currency>sample string 3</Currency>
    <CurrencyCoefficient>4</CurrencyCoefficient>
    <DateTransaction>2026-11-04T07:23:11.0107687+01:00</DateTransaction>
    <Description>sample string 9</Description>
    <PaymentMode>sample string 6</PaymentMode>
    <Refund>true</Refund>
    <Status>64</Status>
    <Total>2</Total>
    <TransactionID>sample string 1</TransactionID>
  </Credit>
</ArrayOfCredit>