Riverty Logo

Create contract

Create contract

PATH:

/api/v3/checkout/{checkoutId}/contract

PATH PARAMETERS:

checkoutId
required

string

REQUEST BODY SCHEMA:

paymentInfo
required

paymentInfo object

Payment info

type
required

string

Enum:InvoiceAccountInstallmentConsolidatedinvoicePayinX

Payment method

contractId

string Format: uuid

Contract ID

directDebit

directDebit object

Direct debit information

bankCode

string <= 11 characters

Direct debit swift, BIC, SortCode

bankAccount
required

string <= 34 characters

Direct debit bank account

token

string <= 50 characters

Unique string provided by Riverty if the merchant is using tokenization. Contact your Integration Manager for more details.

recurringDirectDebit

recurringDirectDebit object

Recurring direct debit information

directDebitAgreement
required

string

Enum:UseExistingCreateNew

bankCode

string <= 11 characters

Direct debit swift, BIC, SortCode

bankAccount

string <= 34 characters

Direct debit bank account. Required when directDebitAgreement value is CreateNew

campaign

campaign object

Campaign information

campaignNumber
required

integer

Campaign number

invoice

Invoice information. Reserved for future use.

account

account object

Used when consumer has chosen flexible installment plan (minimum amount to pay)

profileNo
required

integer

Account Profile number

consolidatedInvoice

consolidatedInvoice object

Consolidate invoice information

invoiceDate

string Format: date-time

Date when invoice will be created.

installment

installment object

Installment information

profileNo
required

integer

Installment profile number

numberOfInstallments

integer

Number of installments

customerInterestRate

number

Customer interest rate

payinX

Pay In X information. Reserverd for future use

RESPONSES:

200 OK

RESPONSE SCHEMA:

contractId

string Format: uuid

Contract ID

requireCustomerConfirmation

boolean

RequireCustomerConfirmation

contractList

array of contractList

Contract list

Array () [
contractType

string

Enum:InvoiceInstallmentDirectDebitAccount

Contract type

contractContent

string <= 4096 characters

Contract content

contractNumber

string <= 50 characters

Contract number

]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/checkout/{checkoutId}/contract

Request samples

  • {
    • "paymentInfo": { ... }
      • {
        • "type": "string",
        • "contractId": "string",
        • "directDebit": { ... }
          • {
            • "bankCode": "string",
            • "bankAccount": "string",
            • "token": "string"
            }
          ,
        • "recurringDirectDebit": { ... }
          • {
            • "directDebitAgreement": "string",
            • "bankCode": "string",
            • "bankAccount": "string"
            }
          ,
        • "campaign": { ... }
          • {
            • "campaignNumber": 1
            }
          ,
        • "invoice": X,
        • "account": { ... }
          • {
            • "profileNo": 1
            }
          ,
        • "consolidatedInvoice": { ... }
          • {
            • "invoiceDate": "string"
            }
          ,
        • "installment": { ... }
          • {
            • "profileNo": 1,
            • "numberOfInstallments": 1,
            • "customerInterestRate": 1.00
            }
          ,
        • "payinX": X
        }
    }

Response samples

200400
  • {
    • "contractId": "string",
    • "requireCustomerConfirmation": true,
    • "contractList": [ { ... }
      • {
        • "contractType": "string",
        • "contractContent": "string",
        • "contractNumber": "string"
        }
      ]
    }
  • {
    • "type": "string",
    • "code": "string",
    • "message": "string",
    • "customerFacingMessage": "string",
    • "actionCode": "string",
    • "fieldReference": "string"
    }
Riverty 2022