order-items — Web API Reference

1. card-alias-order-item-representation

Description: A representation of a card alias order item resource. This is the representation used to create a card alias in the SlimPay system using the create-orders relation. Please ensure the type discriminator is set to cardAlias.

Properties

action: The specific action of the order item. Constraints: Text, set to 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, set to activated or 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 type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

2. card-transaction-order-item-representation

Description: A representation of a card transaction order item resource. This is the representation used to create a card transaction with the create-orders relation. Please ensure the type discriminator is 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 desired date the transaction should be executed. If not provided in the request, the earliest possible date is calculated. Constraints: DateTime, ISO8601, Read-Write.
cardTransaction » operation: The card operation. Text, set to authorization, debit, authorizationDebit, credit, refund, cancel, aliasAuthorization, aliasDebit, aliasCredit, aliasCancel, newAlias or 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, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess, Read-Only.
cardTransaction » dateCreated: The date the resource has been created. Constraints: DateTime, ISO8601, Read-Only.
action: The specific action of the order item. Constraints: Text, set to create.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

3. direct-debit-order-item-representation

Description: A representation of a direct debit order item resource. This is the representation used to create a direct debit with the create-orders relation. Please ensure the type discriminator is 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 of the payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, 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 date the transaction should be executed. If not provided in the request, the earliest possible date is calculated according to the rules of the payment scheme (e.g SEPA). Constraints: DateTime, ISO8601, Read-Write.
directDebit » executionStatus: The direct debit execution status. Constraints: Text, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess, Read-Only.
directDebit » sequenceType: The direct debit sequence type. Constraints: Text, set to FRST, RCUR, FNAL or 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 specific action of the order item. Constraints: Text, set to create.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

4. document-order-item-representation

Description: A representation of a document order item resource. This is the representation used to create and sign a document, using the create-orders relation. The created document also contains related resources like binary content, signatory and billing address. The document reference is optional is the request, it will be generated by SlimPay if not provided. Please ensure the type discriminator is set to document.

Properties

action: The specific action of the order item. Constraints: Text, set to sign.
document » signatory » billingAddress » street1: The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. 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 (optional).
document » signatory » billingAddress » city: The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
document » signatory » billingAddress » postalCode: The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
document » signatory » billingAddress » country: The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.
document » signatory » companyName: The signatory's company name. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » organizationName: The signatory's organization name. Constraints: Text, 24 characters or less, Read-Write.
document » signatory » honorificPrefix: The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » telephone: The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 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: A non-unique document reference. Constraints: Text, Read-Write, 35 characters or less.
document » documentReference: A unique document reference. Generated by SlimPay IS.
document » label: The document label, which can be used to give a human readable description of the document. Constraints: Text, Read-Write, 100 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.
document » status: The document status. Constraints: Text. Set to created, signed, disabled and timestamped, Read-Only.
document » subscriberReference: The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
document » signatory » honorificPrefix: The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
document » signatory » telephone: The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 16 characters or less, must start with a +, Read-Write.
extraParams: Extra parameters are an optional map of key/value pairs to transfer additional document fields to SlimPay. Constraints: Map, Read-Write.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

5. order-item-representation

Description: A representation of an order item resource. An order item is an abstract type whose real type is controlled by the polymorphic type discriminator (for example, signMandate). An order can be created with any number of order item resources using the create-orders relation.

Properties

id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

6. order-items-representation

Description: A collection order item representations.

7. payment-order-item-representation

Description: A representation of a payment order item resource. This is the representation used to create a payment by including a payin resource in the create-orders relation. Please ensure the type discriminator is set to payment.

Properties

action: The specific action of the order item. Constraints: Text, set to 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: Text, 35 characters or less, Read-Write.
payin » scheme: The payment scheme. The payment scheme allows the user to specify whether the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B, SEPA.CREDIT_TRANSFER or CARD, Read-Write
payin » direction: The direction of the payment, from the merchant’s perspective. If funds are being paid from the customer to the merchant, then the direction is IN (payin). If the funds go from the merchant to the customer, then the direction is OUT (payout). Constraints: Text, set to IN or OUT, Read-Write.
payin » category: The payment category (only valid for credit transfers). Constraints: Text, set to funds_transfer, refund or regular, Read-Write.
payin » amount: The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
payin » currency: The currency of the payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
payin » label: Value provided by the user to specify a payment label. Constraints: Text, 140 characters or less, Read-Write.
payin » state: The payment state. Constraints: Text, set to accepted, settling, settled, returned, cancelled, refunded, rejected, reversing or reversed, Read-Only.
payin » executionDate: The desired date the transaction should be executed. If not provided in the request, the earliest possible date is calculated according to the rules of the payment scheme (e.g SEPA). Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Write.
payin » executionStatus: The payment execution status. Constraints: Text, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess, Read-Only.
payin » sequenceType: The payment sequence type. Constraints: Text, set to FRST, RCUR, FNAL or OOFF, Read-Only.
payin » replayCount: The payment replay count. Constraints: Integer, Read-Only.
payin » dateCreated: The date the payment was created. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
payin » dateModified: The date the payment was modified. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
payin » dateBooked: The payment booking date. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
payin » dateValued: The payment value date. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
payin » capture: A flag to indicate whether a card payment should be captured or not (by default set to true). Constraint: Boolean, Read-Write.
payin » confirmed: A flag to indicate whether a payment is confirmed or not (by default set to false). Constraint: Boolean, Read-Only.
payin » processor: The payment processor defines who is responsible for processing the payment. Constraints: Text, set to slimpay, sofort, ideal or unknown, Read-Only.
payin » threeDsPreference: The 3DS preference allows the merchant to inform the issuing bank whether they want to apply Strong Customer Authentication to a one-off transaction. Constraints: Text, set to NoPreference, Challenge, NoChallenge (optional).
payin » correlationId: A correlation property that can be used by external systems for correlation purposes. Constraints: Text, 100 characters or less, Read-Write.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

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

Description: A representation of a recurrent card transaction order item resource. This is the resource used to create a recurrent card transaction with the create-orders relation. Please ensure the type discriminator is set to recurrentCardTransaction.

Properties

action: The specific action of the order item. Constraints: Text, set to 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 each recurrent card transaction that will be created. Constraints: Number, 22 characters or less, Read-Write.
recurrentCardTransaction » currency: The currency of the transactions. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
recurrentCardTransaction » label: Information provided by the user to specify a label for the created card transactions. Constraints: 140 characters or less, Read-Write.
recurrentCardTransaction » frequency: The frequency of the recurrent card transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
recurrentCardTransaction » maxTxNumber: The maximum number of recurrent card transactions that should be created with this payment plan. If not provided, the payment plan will have no limit until cancelled. Constraints: Integer, Read-Write.
recurrentCardTransaction » generatedTxNumber: The current number of card transactions that this payment plan has created. Constraints: Integer, Read-Only.
recurrentCardTransaction » activated: Flag indicating if the recurrent card transaction plan is activated. Constraints: Boolean, Read-Write.
recurrentCardTransaction » dateFrom: The date of the first card transaction creation. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Write.
recurrentCardTransaction » dateNext: The date of the next card transaction creation. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
recurrentCardTransaction » dateDisabled: The date when this recurrent card transaction plan was disabled. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

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

Description: A representation of a recurrent direct debit order item resource. This is the resource used to create a recurrent direct debit with the create-orders relation. Please ensure the type discriminator is set to recurrentDirectDebit

Properties

action: The specific action of the order item. Constraints: Text, set to 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 each recurrent direct debit that will be created. Constraints: Number, 22 characters or less, Read-Write.
recurrentDirectDebit » currency: The currency of the transaction. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
recurrentDirectDebit » label: Information provided by the user to specify a label for the created direct debits. Constraints: 140 characters or less, Read-Write.
recurrentDirectDebit » frequency: The frequency of the direct debit transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
recurrentDirectDebit » maxSddNumber: The maximum number of direct debits that should be created with this payment plan. If not provided, the payment plan will have no limit until cancelled. Constraints: Integer, Read-Write.
recurrentDirectDebit » sddNumber: The current number of direct debits that this payment plan has created. Constraints: Integer, Read-Only.
recurrentDirectDebit » activated: Flag indicating if the recurrent direct debit plan is activated. Constraints: Boolean, Read-Write.
recurrentDirectDebit » dateCreated: The date the resource was created. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
recurrentDirectDebit » dateFrom: The date of the first direct debit creation. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Write.
recurrentDirectDebit » dateNext: The date of the next direct debit creation. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
recurrentDirectDebit » dateDisabled: The date when this recurrent direct debit plan was disabled. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

10. sign-mandate-order-item-representation

Description: A representation of a sign mandate order item resource, used by the create-orders relation to create and sign a mandate. The resulting mandate resource also contains related resources like signatory and billing address, as well as the bank account associated with the mandate. Please ensure the type discriminator is set to signMandate.

Properties

action: The specific action of the order item. Constraints: Text, set to sign or amendBankAccount.
autoGenReference: A true/false flag controlling whether the reference of the mandate should be generated automatically after signature (by default set to true). Constraints: Boolean, Read-Write.
mandate » signatory » billingAddress » street1: The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. 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 (optional).
mandate » signatory » billingAddress » city: The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
mandate » signatory » billingAddress » postalCode: The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
mandate » signatory » billingAddress » country: The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.
mandate » signatory » bankAccount » id: The bank account id. Constraints: 36 characters or less, Read-Only.
mandate » signatory » bankAccount » bic: The BIC (Bank Identifier Code) identifying the account's bank. Optional, SlimPay can always compute a BIC when an IBAN is provided. 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 of the bank. Constraints: Text, 32 characters or less, Read-Only.
mandate » signatory » bankAccount » countryCode: The account's country code. Optional, but if set, then sortCode and accountNumber must also be provided, while iban and bic must not. Constraints: Text, 2 characters, Read-Write.
mandate » signatory » bankAccount » sortCode: The account's sort code. Optional, but if set, then countryCode and accountNumber must also be provided, while iban and bic must not. Constraints: 6 or 8 characters, Read-Write.
mandate » signatory » bankAccount » accountNumber: The account number. Optional, but if set, then sortCode and countryCode must also be provided, while iban and bic must not. Constraints: 8 characters, Read-Write.
mandate » signatory » companyName: The signatory's company name. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » organizationName: The signatory's organization name. Constraints: Text, 24 characters or less, Read-Write.
mandate » signatory » honorificPrefix: The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
mandate » signatory » telephone: The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 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, set to created, waitingForReference, waitingForValidation, active, rejected, revoked or expired, Read-Only.
mandate » standard: The payment standard. Default: SEPA. Constraints: Text among SEPA, Read-Write.
mandate » paymentScheme: The payment scheme. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE or SEPA.DIRECT_DEBIT.B2B, 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, set to RCUR or OOFF, Read-Only.
mandate » createSequenceType: The create mandate sequence type. Constraints: Text, set to FRST, RCUR, FNAL or 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, set to slimpay, sofort, ideal or unknown, Read-Only.
signatureApproval » method » type: The signature approval method type, defining how the signature approval is gathered. Constraints: Text, set to otp, checkbox or payment, Read-Write.
extraParams: Extra parameters are an optional map of key/value pairs to transfer additional mandate fields to SlimPay. Constraints: Map, Read-Write.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: 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 representation of a subscriber login order item resource. This is the order item used to retrieve a user-approval URL; a webpage a customer is redirected to so they can manage their mandates, change their bank account etc (depending on the mode property setting). This order item must be used exclusively of any other order item. Please ensure the type discriminator is set to subscriberLogin.

Properties

action: The specific action of the order item. Constraints: Text, set to create.
mode » type: A mandatory mode discriminator designating the type of subscriber login to be executed. Constraints: Text, set to manageMandates (to manage mandates) or recoverDebt (to recover debt), Read-Write
mode » cardOperation: A card operation. This property must be included when the mode type is set to recoverDebt. Constraints: Text, set to authorization or authorizationDebit, Read-Write
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

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

Description: A representation of a template-based document order item resource, used by the create-orders relation to create and sign a template document. The resulting document resource also contains related resources like signatory and billing address. Please ensure the type discriminator is set to templateBasedDocument.

Properties

action: The specific action of the order item. Constraints: Text, set to sign.
reference: A document reference. If no value is provided in the request, it will be generated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
label: A document label, which is a human readable description of the document. Constraints: Text, 100 characters or less, Read-Write.
extraParams: Extra parameters are an optional map of key/value pairs to transfer additional document template fields to SlimPay. Constraints: Map, Read-Write.
documentTemplate » id: The document template id. Constraints: 36 characters or less, Read-Only.
documentTemplate » reference: The document template reference. Constraints: Text, Read-Write, 35 characters or less.
documentTemplate » dateCreated: The creation date. Constraints: DateTime, Read-Only.
documentTemplate » name: The document template unique name. Constraints: Text, Mandatory, Read-Write, 35 characters or less.
documentTemplate » fileName: The document template file name. Constraints: Text, Mandatory, Read-Write, 255 characters or less.
documentTemplate » content: The document template binary content. Constraints: Text, Read-Write.
documentTemplate » missingParameters: The document template list of missing parameters. Constraints: List of strings, Read-Only.
signatory » billingAddress » street1: The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. 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 (optional).
signatory » billingAddress » city: The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
signatory » billingAddress » postalCode: The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
signatory » billingAddress » country: The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.
signatory » companyName: The signatory's company name. Constraints: Text, 70 characters or less, Read-Write.
signatory » organizationName: The signatory's organization name. Constraints: Text, 24 characters or less, Read-Write.
signatory » honorificPrefix: The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
signatory » telephone: The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 16 characters or less, must start with a +, Read-Write.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

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

Description: A representation of a template-based mandate order item resource, used by the create-orders relation to create and sign a template mandate. The resulting mandate resource also contains related resources like signatory and billing address. Please ensure the type discriminator is set to templateBasedMandate.

Properties

action: The specific action of the order item. Constraints: Text, set to sign.
reference: A mandate reference. If no value is provided in the request, it will be generated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
extraParams: Extra parameters are an optional map of key/value pairs to transfer additional mandate template fields to SlimPay. Constraints: Map, Read-Write.
mandateTemplate » id: The mandate template id. Constraints: 36 characters or less, Read-Only.
mandateTemplate » reference: The mandate template reference. Constraints: Text, Read-Write, 35 characters or less.
mandateTemplate » name: The mandate template unique name. Constraints: Text, Mandatory, Read-Write, 35 characters or less.
mandateTemplate » fileName: The mandate template file name. Constraints: Text, Mandatory, Read-Write, 255 characters or less.
mandateTemplate » defaultTemplate: Define if the concerned mandate template will be the default one or not. Constraints: Boolean.
signatory » billingAddress » street1: The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. 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 (optional).
signatory » billingAddress » city: The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
signatory » billingAddress » postalCode: The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
signatory » billingAddress » country: The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.
signatory » companyName: The signatory's company name. Constraints: Text, 70 characters or less, Read-Write.
signatory » organizationName: The signatory's organization name. Constraints: Text, 24 characters or less, Read-Write.
signatory » honorificPrefix: The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
signatory » telephone: The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 16 characters or less, must start with a +, Read-Write.
autoGenReference: A true/false flag controlling whether the reference of the mandate should be generated automatically after signature (by default set to true). Constraints: Boolean, Read-Write.
id: The order item id. Constraints: 36 characters or less, Read-Only.
type: The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: 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 type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.

15. get-order-items (relation)

Description: Retrieve the representation of an order item resource.

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: Retrieve order item representations

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 for the representation of a specific order item resource, using its id parameter.

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"
        }
    }
}