Digiteal

Table of Contents

• Context
  • password
  • username
  • integratorAccountNumber
  • apiUrl
  • integratorTaxIdentificationNumber
• Actions
  • Prepare Customer Order
  • Create Refund
  • Validate Payment
  • Dispatch Money Between Seller And Operator
  • Create Account
• Events
  • Payment Update
  • Onboarding Update

Contexts

password

username

integratorAccountNumber

apiUrl

integratorTaxIdentificationNumber

Actions

Prepare Customer Order

Prepare the PSP to have a new order by collecting pieces of information.

Inputs

{
  "customerOrderId": "string", /*(required)*/
  "customerId": "string", /*(required)*/
  "sellerOrders": [ /*(required)*/
    {
      "sellerId": "string", /*(required)*/
      "sellerOrderId": "string", /*(required)*/
      "amount": "string", /*Amount in currency(required)*/
      "currency": "string", /*(required)*/
    }
  ]
  "payment": { /*(required)*/
    "method": "string", /*(required)*/
    "data": { /*(required)*/
      "trustedPayments": [ /*Trusted payment data for each seller order(required)*/
        {
          "sellerOrderId": "string", /*(required)*/
          "paymentId": "string", /*UUID of payment in Digiteal(required)*/
          "transferId": "string", /*Id of the digitrust corresponding to this seller order*/
          "sellerTransferReference": "string", /*Reference of the transfert to the seller within the digitrust*/
          "marketplaceTransferReference": "string", /*Reference of the transfert to the marketplace within the digitrust*/
        }
      ]
    }
  }
}

Outputs

Http Code 200

{
  "message": "string"
}

Http Code 500

{
  "message": "string"
}

Create Refund

Create a refund for a seller order

Inputs

{
  "sellerOrderId": "string", /*(required)*/
  "amount": "number", /*Amount in currency(required)*/
}

Outputs

Validate Payment

Validate the payment of a seller order

Inputs

{
  "sellerOrderId": "string", /*(required)*/
  "amount": "number", /*Amount in currency(required)*/
}

Outputs

Http Code 200

{
  "isAsyncNeeded": "boolean"
}

Http Code 400

"Bad Request"

Http Code 401

"Unauthorized"

Http Code 404

"Not found"

Http Code 500

"Internal server error occured"

Dispatch Money Between Seller And Operator

Documentation

<p> The split of trust payments is updated based on the subscription fee and the TransferredToOperator amount before being confirmed by the Digiteal API. </p>

Inputs

{
  "header": { /*(required)*/
    "invoiceId": "number", /*(required)*/
    "sellerId": "number", /*(required)*/
    "currencyIsoCode": "string", /*(required)*/
    "amountTransferredToSeller": "number", /*(required)*/
    "amountTransferredToOperator": "number", /*(required)*/
  }
  "transactions": [ /*(required)*/
    {
      "type": "string", /*(required)*/
      "amount": "number", /*Amount in currency(required)*/
      "entities": [ /*(required)*/
        {
          "type": "string", /*(required)*/
          "id": "string", /*(required)*/
        }
      ]
    }
  ]
}

Outputs

Create Account

Onboard a new seller

Inputs

{
  "id": "string", /*(required)*/
  "type": "string", /*(required)*/
  "corporateName": "string", /*(required)*/
  "identificationNumber": "string", /*(required)*/
  "taxIdentificationNumber": "string",
  "accountingContact": { /*(required)*/
    "email": "string", /*(required)*/
    "phone": "string", /*(required)*/
  }
  "bankAccount": { /*(required)*/
    "currencyCode": "string", /*(required)*/
    "accountNumber": "string", /*(required)*/
    "bicSwiftNumber": "string", /*(required)*/
    "countryCode": "string", /*(required)*/
  }
  "documents": [ /*(required)*/
    {
      "type": "string", /*(required)*/
      "marjoryFile": { /*(required)*/
        "id": "string", /*(required)*/
        "name": "string", /*(required)*/
        "link": "string", /*(required)*/
      }
    }
  ]
  "peoples": [ /*(required)*/
    {
      "relationship": { /*(required)*/
        "isDirector": "boolean", /*(required)*/
        "isExecutive": "boolean",
        "isRepresentative": "boolean", /*(required)*/
        "isOwner": "boolean", /*(required)*/
        "jobTitle": "string", /*required if is director*/
      }
      "address": { /*(required)*/
        "street1": "string", /*(required)*/
        "street2": "string", /*(required)*/
        "city": "string", /*(required)*/
        "state": "string",
        "zipCode": "string", /*(required)*/
        "countryCode": "string", /*(required)*/
      }
      "civility": "string",
      "birthDate": "string", /*(required)*/
      "nationalityCountryCode": "string", /*(required)*/
      "email": "string",
      "firstName": "string", /*(required)*/
      "lastName": "string", /*(required)*/
      "documents": [ /*(required)*/
        {
          "type": "string", /*(required)*/
          "marjoryFile": { /*(required)*/
            "id": "string",
            "name": "string", /*(required)*/
            "contentType": "string",
            "link": "string", /*(required)*/
            "size": "number", /*(required)*/
            "lastModified": "string",
          }
        }
      ]
    }
  ]
}

Outputs

Http Code 200

{
  "message": "string"
}

Http Code 500

{
  "message": "string"
}

Events

Payment Update

Payment status updated

Payload

{
  "sellerOrderId": "string", /*(required)*/
  "status": "string", /*(required)*/
  "statusMessage": "string", /*(required)*/
}

Onboarding Update

Seller onboarding status updated

Documentation

<p> <strong>Request and functionnal rules:</strong>

• This event is sent when Digiteal's CompanyNotification event is received by webhook.
• status is OK if changeType from CompanyEvent is VALIDATED
• status is KO if changeType from CompanyEvent is PUT_ON_HOLD or REJECTED </p>

Payload

{
  "sellerId": "string", /*(required)*/
  "status": "string", /*(required)*/
  "statusMessage": "string", /*(required)*/
}