Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

order-items

  1. card-alias-order-item-representation
  2. card-transaction-order-item-representation
  3. direct-debit-order-item-representation
  4. document-order-item-representation
  5. order-item-representation
  6. order-items-representation
  7. payment-order-item-representation
  8. recurrent-card-transaction-order-item-representation
  9. recurrent-direct-debit-order-item-representation
  10. sign-mandate-order-item-representation
  11. subscriber-login-order-item-representation
  12. template-based-document-order-item-representation
  13. template-based-mandate-order-item-representation
  14. create-order-items
  15. get-order-items
  16. search-order-item-by-id

1. card-alias-order-item-representation

Description: A card alias order item representation. A card alias order item is the item to use in order to create a card alias. Must have its type set to cardAlias.

Properties
action
The order item action. Constraint: Text among create
cardAlias » id
The card alias id. Constraints: 36 characters or less, Read-Only.
cardAlias » reference
The card alias reference. Constraints: Text, 250 characters or less, Read-Write.
cardAlias » status
The card alias status. Text among activated|deleted, Read-Only.
cardAlias » cardExpirationDate
The card expiration date. Constraints: DateTime, ISO8601, Read-Only.
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

2. card-transaction-order-item-representation

Description: A card transaction order item representation. A card transaction order item is the item to use in order to create a card transaction. Must have its type set to cardTransaction.

Properties
cardTransaction » id
The card transaction id. Constraints: 36 characters or less, Read-Only.
cardTransaction » amount
The transaction amount. Constraints: Number, 22 characters or less, Read-Write.
cardTransaction » executionDate
The date the transaction should be executed. If not provided at creation, the next shorter possible date is chosen. Constraints: DateTime, ISO8601, Read-Write.
cardTransaction » operation
The card operation. Text among authorization|debit|authorizationDebit|credit|refund|cancel|aliasAuthorization|aliasDebit|aliasCredit|aliasCancel|newAlias|aliasDelete, Read-Write.
cardTransaction » returnCode
The return code. Constraints: Text, 12 characters or less, Read-Only.
cardTransaction » result
The result. Constraints: Integer, 11 characters or less, Read-Only.
cardTransaction » transactionId
The card transaction id. Constraints: Text, 50 characters or less, Read-Only.
cardTransaction » reference
The card transaction reference. Constraints: Text, 250 characters or less, Read-Write.
cardTransaction » label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
cardTransaction » executionStatus
The card transaction execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
cardTransaction » dateCreated
The date the resource has been created. Constraints: DateTime, ISO8601, Read-Only.
action
The order item action. Constraint: Text among create
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

3. direct-debit-order-item-representation

Description: A direct debit order item representation. A direct debit order item is the item to use in order to create a direct debit. A direct-debit-order-item representation must have the type discriminator set to directDebit

Properties
directDebit » id
The direct debit id. Constraints: 36 characters or less, Read-Only.
directDebit » amount
The amount of the direct debit. Constraints: Number, 22 characters or less, Read-Write.
directDebit » currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
directDebit » paymentReference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
directDebit » label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
directDebit » executionDate
The desired direct debit execution date. If missing from the request, the closest possible value is computed according to the rules of the payment scheme (SEPA, BACS etc.). Constraints: 140 characters or less, Read-Write.
directDebit » executionStatus
The direct debit execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
directDebit » sequenceType
The direct debit sequence type. Constraints: Text among FRST|RCUR|FNAL|OOFF, Read-Only.
directDebit » replayCount
The direct debit replay count. Constraints: Integer, Read-Only.
directDebit » dateCreated
The date the mandate has been created. Constraints: DateTime, ISO8601, Read-Only.
directDebit » dateBooked
The direct debit booking date. Constraints: DateTime, ISO8601, Read-Only.
directDebit » dateValued
The direct debit value date. Constraints: DateTime, ISO8601, Read-Only.
action
The order item action. Constraint: Text among create
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

4. document-order-item-representation

Description: A document order item representation. A document order item is the item to use in order to create and sign a document. The document reference is optional when given in the request. It will be generated by Slimpay if no value given. A document-order-item representation must have the type discriminator set to document

Properties
action
The order item action. Constraint: Text among sign
document » signatory » billingAddress » street1
The first line of the street address. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » billingAddress » street2
The second line of the street address. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » billingAddress » city
The city of the address. Constraints: Text, 35 characters or less, Read-Write.
document » signatory » billingAddress » postalCode
The postal code of the debtor's invoicing address. Constraints: Text, 15 characters or less, Read-Write.
document » signatory » billingAddress » country
The country of the address (For France : FR). Constraints: Text, ISO3166, Read-Write.
document » signatory » companyName
The company name. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » organizationName
An organization name. Constraints: Text, 24 characters or less, Read-Write.
document » signatory » honorificPrefix
The honorific prefix of the person. Constraints: Text among Mr|Miss|Mrs, Read-Write.
document » signatory » familyName
The family name of the person. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » givenName
The given name of the person. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write.
document » signatory » email
The email of the person. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » telephone
The telephone of the person. Constraints: Text, 16 characters or less, must start with a +, Read-Write.
document » binaryContent » contentType
The MIME type of the binary-content. Example: application/pdf. Constraints: Text, Read-Write.
document » binaryContent » contentEncoding
The content encoding. Constraints: Text among Base64, Read-Write.
document » binaryContent » content
The actual binary content. Constraints: Text, Read-Write.
document » id
The document id. Constraints: 36 characters or less, Read-Only.
document » reference
The document reference. Constraints: Text, Read-Write, 35 characters or less.
document » label
The document label, which can be used to give a human readable description of the document. Constraints: Text, Read-Write, 140 characters or less.
document » timestamped
A flag specifying if the document should be/is timestamped. Constraints: Boolean, Read-Write.
document » timestamp
The document timestamp with regards to RFC 3161. Constraints: DateTime, Read-Only.
document » dateCreated
The creation date. Constraints: DateTime, Read-Only.
document » dateSigned
The signed date. Constraints: DateTime, Read-Only.
extraParams
Extra parameters are the additional parameters transferring to Slimpay for a specific purpose. Constraints: Map
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

5. order-item-representation

Description: An order item representation. An order item is an abstract type whose real type is controlled by the type descriptor which is the disciminator for polymorphic typing.

Properties
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

6. order-items-representation

Description: A collection of order items.

7. payment-order-item-representation

Description: A payment order item representation. A payment order item is the item to use in order to create a payment. Must have its type set to payment.

Properties
action
The order item action. Constraint: Text among create
payin » id
The payment id. Constraints: 36 characters or less, Read-Only.
payin » reference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
payin » scheme
The payment scheme. The payment scheme allows to specify is the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text among SEPA.DIRECT_DEBIT.CORE|SEPA.DIRECT_DEBIT.B2B|SEPA.CREDIT_TRANSFER|BACS.DIRECT_DEBIT|CARD, Read-Write
payin » direction
The payment direction. The payment direction is to be considered from the merchants point of view. If the money goes from the customer to the merchant, then the direction is IN and the payment can be called a payin. If the money goes from the merchant to the customer, then the direction is OUT and the payment can be considered a payout. Constraints: Text among IN|OUT, Read-Write.
payin » category
The payment category. Only valid for credit transfers. Constraints: Text among funds_transfer|refund|regular, Read-Write
payin » amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
payin » currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
payin » label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
payin » state
The payment state. Constraints: Text among accepted|settling|settled|returned|cancelled|refunded|rejected|reversing|reversed, Read-Only.
payin » executionDate
The desired payment execution date. If missing from the request, the closest possible value is computed according to the rules of the payment scheme (SEPA, BACS etc.). Constraints: 140 characters or less, Read-Write.
payin » executionStatus
The payment execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
payin » sequenceType
The payment sequence type. Constraints: Text among FRST|RCUR|FNAL|OOFF, Read-Only.
payin » replayCount
The payment replay count. Constraints: Integer, Read-Only.
payin » dateCreated
The date the payment has been created. Constraints: DateTime, ISO8601, Read-Only.
payin » dateModified
The date the payment has been created. Constraints: DateTime, ISO8601, Read-Only.
payin » dateBooked
The payment booking date. Constraints: DateTime, ISO8601, Read-Only.
payin » dateValued
The payment value date. Constraints: DateTime, ISO8601, Read-Only.
payin » capture
A flag to indicate whether a card payment should be captured or not. Default: true. Constraint: Boolean, Read-Write.
payin » confirmed
A flag to indicate whether a payment is confirmed or not. Default: false. Constraint: Boolean, Read-Only.
payin » processor
The payment processor defines who is responsible for processing the payment. Constraints: Text among slimpay|sofort|ideal|unknown, Read-Only.
payin » correlationId
A correlation property that can be used by external systems for correlation purpose. Constraints: 100 characters or less, Read-Write.
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

8. recurrent-card-transaction-order-item-representation

Description: A recurrent card transaction order item representation. Must have its type set to recurrentCardTransaction.

Properties
action
The order item action. Constraint: Text among create
recurrentCardTransaction » id
The recurrent card transaction id. Constraints: 36 characters or less, Read-Only.
recurrentCardTransaction » reference
The recurrent card transaction reference. Constraints: 35 characters or less, Read-Write.
recurrentCardTransaction » amount
The amount of card transactions that will be created. Constraints: Number, 22 characters or less, Read-Write.
recurrentCardTransaction » currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
recurrentCardTransaction » label
Value provided by the user to specify a label for created card transaction. Constraints: 35 characters or less, Read-Write.
recurrentCardTransaction » frequency
The frequency of card transaction creation. Constraints: Text among daily|weekly|monthly|bimonthly|trimonthly|semiyearly|yearly|biyearly, Read-Write.
recurrentCardTransaction » maxTxNumber
The maximum number of card transactions that should be created with this recurrent card transaction. Constraints: Integer, Read-Write.
recurrentCardTransaction » generatedTxNumber
The current of card transactions that this recurrent card transaction has created. Constraints: Integer, Read-Only.
recurrentCardTransaction » activated
Flag indicating if the card transaction is activated. Constraints: Boolean, Read-Write.
recurrentCardTransaction » dateFrom
The date of the first card transaction creation. Constraints: DateTime, ISO8601, Read-Write.
recurrentCardTransaction » dateNext
The date of the next card transaction creation. Constraints: DateTime, ISO8601, Read-Only.
recurrentCardTransaction » dateDisabled
The date when this recurrent card transaction has been disabled. Constraints: DateTime, ISO8601, Read-Only.
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

9. recurrent-direct-debit-order-item-representation

Description: A recurrent direct debit order item representation. A recurrent direct debit is the item to use in order to create a recurrent direct debit. A recurrent-direct-debit-order-item representation must have the type discriminator set to recurrentDirectDebit

Properties
action
The order item action. Constraint: Text among create
recurrentDirectDebit » id
The recurrent direct debit id. Constraints: 36 characters or less, Read-Only.
recurrentDirectDebit » reference
The recurrent direct debit reference. Constraints: 35 characters or less, Read-Write.
recurrentDirectDebit » amount
The amount of direct debits that will be created. Constraints: Number, 22 characters or less, Read-Write.
recurrentDirectDebit » currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
recurrentDirectDebit » label
Value provided by the user to specify a label for created direct debits. Constraints: 140 characters or less, Read-Write.
recurrentDirectDebit » frequency
The frequency of direct debit creation. Constraints: Text among daily|weekly|monthly|bimonthly|trimonthly|semiyearly|yearly|biyearly, Read-Write.
recurrentDirectDebit » maxSddNumber
The maximum number of direct debits that should be created with this recurrent direct debit. Constraints: Integer, Read-Write.
recurrentDirectDebit » sddNumber
The current of direct debits that this recurrent direct debit has created. Constraints: Integer, Read-Only.
recurrentDirectDebit » activated
Flag indicating if the direct debit is activated. Constraints: Boolean, Read-Write.
recurrentDirectDebit » dateCreated
The date the resource has been created. Constraints: DateTime, ISO8601, Read-Only.
recurrentDirectDebit » dateFrom
The date of the first direct debit creation. Constraints: DateTime, ISO8601, Read-Write.
recurrentDirectDebit » dateNext
The date of the next direct debit creation. Constraints: DateTime, ISO8601, Read-Only.
recurrentDirectDebit » dateDisabled
The date when this recurrent direct debit has been disabled. Constraints: DateTime, ISO8601, Read-Only.
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

10. sign-mandate-order-item-representation

Description: A sign mandate order item representation. A sign mandate order item is the item to use in order to create and sign a mandate. A sign mandate order item representation must have the type discriminator set to signMandate

Properties
action
The order item action. Constraint: Text among sign|amendBankAccount
autoGenReference
Controls whether the reference of the mandate should be generated automatically after signature. Default: true. Constraints: Boolean, Read-Write.
mandate » signatory » billingAddress » street1
The first line of the street address. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » billingAddress » street2
The second line of the street address. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » billingAddress » city
The city of the address. Constraints: Text, 35 characters or less, Read-Write.
mandate » signatory » billingAddress » postalCode
The postal code of the debtor's invoicing address. Constraints: Text, 15 characters or less, Read-Write.
mandate » signatory » billingAddress » country
The country of the address (For France : FR). Constraints: Text, ISO3166, Read-Write.
mandate » signatory » bankAccount » id
The account id. Constraints: 36 characters or less, Read-Only.
mandate » signatory » bankAccount » bic
The BIC (Bank Identifier Code) identifying the bank. Constraints: Text, 11 characters or less, Read-Write.
mandate » signatory » bankAccount » iban
The IBAN (International Bank Account Number) identifying the bank account. Constraints: Text, 34 characters or less, Read-Write.
mandate » signatory » bankAccount » institutionName
The institution name. Constraints: Text, 32 characters or less, Read-Only.
mandate » signatory » bankAccount » countryCode
The country code. If set, then sortCode and accountNumber must be set, while iban and bic must not. Constraints: Text, 2 characters, Read-Write.
mandate » signatory » bankAccount » sortCode
The sort code. If set, then countryCode and accountNumber must be set, while iban and bic must not. Constraints: 6 or 8 characters, Read-Write.
mandate » signatory » bankAccount » accountNumber
The account number. If set, then sortCode and countryCode must be set, while iban and bic must not. Constraints: 8 characters, Read-Write.
mandate » signatory » companyName
The company name. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » organizationName
An organization name. Constraints: Text, 24 characters or less, Read-Write.
mandate » signatory » honorificPrefix
The honorific prefix of the person. Constraints: Text among Mr|Miss|Mrs, Read-Write.
mandate » signatory » familyName
The family name of the person. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » givenName
The given name of the person. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write.
mandate » signatory » email
The email of the person. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » telephone
The telephone of the person. Constraints: Text, 16 characters or less, must start with a +, Read-Write.
mandate » id
The mandate id. Constraints: 36 characters or less, Read-Only.
mandate » reference
The Unique Reference of the Mandate (attributed by SlimPay if not set by the merchant). Constraints: Text, 35 characters or less, Read-Write.
mandate » rum
DEPRECATED, use reference instead. The Unique Reference of the Mandate (attributed by SlimPay if not set by the merchant). Constraints: Text, 35 characters or less, Read-Write.
mandate » state
The mandate state. Constraints: Text among created|waitingForReference|waitingForValidation|active|rejected|revoked|expired, Read-Only.
mandate » standard
The payment standard. Default: SEPA. Constraints: Text among SEPA, Read-Write.
mandate » paymentScheme
The payment scheme. Constraints: Text among SEPA.DIRECT_DEBIT.CORE|SEPA.DIRECT_DEBIT.B2B|BACS.DIRECT_DEBIT, Read-Write
mandate » initialScore
The payment score. The score is calculated considering many complex parameters and evaluates the risk associated to a payment. 0 is the lowest risk, while 10 is the highest risk. Constraints: Integer between 0 and 10, Read-Only.
mandate » sequenceType
The mandate sequence type. Constraints: Text among RCUR|OOFF, Read-Only.
mandate » createSequenceType
The create mandate sequence type. Constraints: Text among FRST|RCUR|FNAL|OOFF, Read-Write.
mandate » dateCreated
The date the mandate has been created. Constraints: DateTime, ISO8601, Read-Only.
mandate » dateRevoked
The date the mandate has been revoked. Constraints: DateTime, ISO8601, Read-Only.
mandate » dateSigned
The date the mandate has been signed. Constraints: DateTime, ISO8601, Read-Write.
signatureApproval » id
The signature approval id. Constraints: 36 characters or less, Read-Only.
signatureApproval » paymentProcessor
The payment processor defines who is responsible for processing the payment. Constraints: Text among slimpay|sofort|ideal|unknown, Read-Only.
signatureApproval » method » type
The payment method type. Constraints: Text among otp|checkbox|payment, Read-Write.
extraParams
Extra parameters are the additional parameters transferring to Slimpay for a specific purpose. Constraints: Map
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.
Example: A mandate order-item representation
{
    "action": "sign",
    "autoGenReference": true,
    "id": "acf56cf0-d70e-11e6-ba63-000000000001",
    "type": "signMandate",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/order-items/acf56cf0-d70e-11e6-ba63-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/order-items"
        },
        "https://api.slimpay.net/alps#get-order-items": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001/order-items"
        },
        "https://api.slimpay.net/alps#get-order": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/order-items/acf56cf0-d70e-11e6-ba63-000000000001/mandate"
        }
    }
}

11. subscriber-login-order-item-representation

Description: A subscriber login order item representation. A subscriber login order item is the item to use in order to retrieve a user-approval URL to which a user can redirected so that he is able to manage its mandates, change the bank account etc (depending on the mode property). A subscriber-login-order-item-representation must have the type discriminator set to subscriberLogin. This item must be used exclusively of any other item.

Properties
action
The order item action. Constraint: Text among create
mode » type
A mode type (discriminator). Constraints: Mandatory, Text among manageMandates|recoverDebt, Read-Write
mode » cardOperation
A card operation. Must be present when type == recoverDebt. Constraints: Text among authorization|authorizationDebit, Read-Write
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

12. template-based-document-order-item-representation

Description: A template based document representation. A template based document order item is the item to use in order to create and sign a template document. A template-based-document-order-item-representation representation must have the type discriminator set to templateBasedDocument

Properties
action
The order item action. Constraint: Text among sign
reference
A document reference, which is optional when given in the request. It will be generated by Slimpay if no value given. Constraints: Text, Read-Write, 35 characters or less.
label
A document label, which can be used to give a human readable description of the document. Constraints: Text, Read-Write, 140 characters or less.
extraParams
Extra parameters, which are used to fill template document annotations (parameters). Constraints: Map
documentTemplate » reference
The document template reference. Constraints: Text, Read-Write, 35 characters or less.
documentTemplate » dateCreated
The creation date. Constraints: DateTime, Read-Only.
signatory » billingAddress » street1
The first line of the street address. Constraints: Text, 70 characters or less, Read-Write.
signatory » billingAddress » street2
The second line of the street address. Constraints: Text, 70 characters or less, Read-Write.
signatory » billingAddress » city
The city of the address. Constraints: Text, 35 characters or less, Read-Write.
signatory » billingAddress » postalCode
The postal code of the debtor's invoicing address. Constraints: Text, 15 characters or less, Read-Write.
signatory » billingAddress » country
The country of the address (For France : FR). Constraints: Text, ISO3166, Read-Write.
signatory » companyName
The company name. Constraints: Text, 70 characters or less, Read-Write.
signatory » organizationName
An organization name. Constraints: Text, 24 characters or less, Read-Write.
signatory » honorificPrefix
The honorific prefix of the person. Constraints: Text among Mr|Miss|Mrs, Read-Write.
signatory » familyName
The family name of the person. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write.
signatory » givenName
The given name of the person. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write.
signatory » email
The email of the person. Constraints: Text, 70 characters or less, Read-Write.
signatory » telephone
The telephone of the person. Constraints: Text, 16 characters or less, must start with a +, Read-Write.
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

13. template-based-mandate-order-item-representation

Description: A template based mandate order item representation. A template based mandate order item is the item to use in order to create and sign a template mandate. A template-based-mandate-order-item-representation representation must have the type discriminator set to templateBasedMandate

Properties
action
The order item action. Constraint: Text among sign
reference
A mandate reference, which is optional when given in the request. It will be generated by Slimpay if no value given. Constraints: Text, Read-Write, 35 characters or less.
extraParams
Extra parameters, which are used to fill template mandate annotations (parameters). Constraints: Map
mandateTemplate » reference
The mandate template reference. Constraints: Text, Read-Write, 35 characters or less.
signatory » billingAddress » street1
The first line of the street address. Constraints: Text, 70 characters or less, Read-Write.
signatory » billingAddress » street2
The second line of the street address. Constraints: Text, 70 characters or less, Read-Write.
signatory » billingAddress » city
The city of the address. Constraints: Text, 35 characters or less, Read-Write.
signatory » billingAddress » postalCode
The postal code of the debtor's invoicing address. Constraints: Text, 15 characters or less, Read-Write.
signatory » billingAddress » country
The country of the address (For France : FR). Constraints: Text, ISO3166, Read-Write.
signatory » companyName
The company name. Constraints: Text, 70 characters or less, Read-Write.
signatory » organizationName
An organization name. Constraints: Text, 24 characters or less, Read-Write.
signatory » honorificPrefix
The honorific prefix of the person. Constraints: Text among Mr|Miss|Mrs, Read-Write.
signatory » familyName
The family name of the person. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write.
signatory » givenName
The given name of the person. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write.
signatory » email
The email of the person. Constraints: Text, 70 characters or less, Read-Write.
signatory » telephone
The telephone of the person. Constraints: Text, 16 characters or less, must start with a +, Read-Write.
id
The order item id. Constraints: 36 characters or less, Read-Only.
type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

14. create-order-items (relation)

Description: Create an order item.

Properties
order-item-representation » id
The order item id. Constraints: 36 characters or less, Read-Only.
order-item-representation » type
The item type as documented in the concrete order items. For instance, a value of "signMandate" identifies the order item type as being a #sign-mandate-order-item-representation. Order items willConstraints: Text, Read-Write.

15. get-order-items (relation)

Description: Get order items.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

Example: Get order items
Request
GET follow(https://api.slimpay.net/alps#get-order-items) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1541

{
    "_embedded": {
        "items": [
            {
                "type": "signMandate",
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/order-items/acf56cf0-d70e-11e6-ba63-000000000001"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/order-items"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001/order-items"
                    },
                    "https://api.slimpay.net/alps#get-order": {
                        "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/order-items/acf56cf0-d70e-11e6-ba63-000000000001/mandate"
                    }
                },
                "action": "sign",
                "autoGenReference": true,
                "id": "acf56cf0-d70e-11e6-ba63-000000000001"
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001/order-items"
        },
        "https://api.slimpay.net/alps#get-order": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        }
    }
}

16. search-order-item-by-id (relation)

Description: Search one order item by id.

Properties
id
The order item id. Constraints: 36 characters or less, Read-Only.
Example: Search one order item by id
Request
GET follow(https://api.slimpay.net/alps#search-order-item-by-id) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 971

{
    "action": "sign",
    "autoGenReference": true,
    "id": "acf56cf0-d70e-11e6-ba63-000000000001",
    "type": "signMandate",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/order-items/acf56cf0-d70e-11e6-ba63-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/order-items"
        },
        "https://api.slimpay.net/alps#get-order-items": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001/order-items"
        },
        "https://api.slimpay.net/alps#get-order": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/order-items/acf56cf0-d70e-11e6-ba63-000000000001/mandate"
        }
    }
}