Skip to Main Content
Riverty Docs
    riverty logo Docs

    #Add payment

    Path

    POST /businesses/{businessCode}/customers/{customerNumber}/orders/{orderReference}/payments

    Request Parameters

    businessCode
    required
    string
    The business in the context of which this request is to be executed, e.g. 1000
    customerNumber
    required
    string
    The customer in the context of which this request is to be executed, e.g. TFI2021072801
    orderReference
    required
    string
    The order in the context of which this request is to be executed, e.g. TFI2021072801_03
    X-Request-ID
    string
    The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

    Request Body

    application/json

    authorizedAmount
    number
    Values(>0)
    Amount paid; if the amount is not provided, then the system assumes that the entire order has been paid
    paymentProvider
    string
    Max length: 30
    maxLength(30)
    Name of the payment provider

    Responses

    • internalRequestId
      required
      string
      The internal ID (i.e. receipt) of the message as received by the system
    • array
      action
      string
      External action to be triggered based on error code/message
      code
      string
      Code of third party error.
      customerFacingMessage
      string
      Customer facing message of third party error.
      description
      string
      Description of third party error.
      fieldReference
      string
      Field reference of third party error.
      source
      string
      Source of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPal
      title
      string
      Title of third party error.
      type
      string
      Type or class of third party error.
      code
      string
      Error code.
      description
      string
      Error description.
      title
      string
      Error title.
      type
      string
      Error type.
    • array
      action
      string
      External action to be triggered based on error code/message
      code
      string
      Code of third party error.
      customerFacingMessage
      string
      Customer facing message of third party error.
      description
      string
      Description of third party error.
      fieldReference
      string
      Field reference of third party error.
      source
      string
      Source of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPal
      title
      string
      Title of third party error.
      type
      string
      Type or class of third party error.
      code
      string
      Error code.
      description
      string
      Error description.
      title
      string
      Error title.
      type
      string
      Error type.