7. Multipayments

Multipayment is a payment collection associated with a multiorder. Used for the implementation of trolleys with more than one storekeeper and situations in which it is necessary to charge different items differently within a single checkout. When creating a multi-payment, Wirecard creates a payment for each order in the multiorder and automatically charges it.

In cases of credit card, multiple authorizations are generated, one for each payment, separating the charges on the customer's invoice, and thereby facilitating the management of the Marketplace or Platform.

Atributtes

Name

Description

Detail

id

Wirecard multipayment id.

string(16),
response

status

Multipayment statuses. Possible values: WAITING, IN_ANALYSIS, PRE_AUTHORIZED, AUTHORIZED, CANCELLED, REFUNDED, REVERSED.

string,
response

amount

Multipayment values.

structured

├─currency

Currency used for payment. Possible values: BRL.

string,
response

└─total

The total amount of multipayment. In cents . Ex: R$10.32 will be informed 1032.

integer(12),
response

installmentCount

Installments number. Minimum 1 e Maximum 12.

integer(2)

delayCapture

Whether payment must be pre-authorized for later capture. Valid only for payments by credit card.

boolean

fundingInstrument

Payment method structure.

structured

├─method

Payment method. Possible values: CREDIT_CARD, BOLETO, ONLINE_BANK_DEBIT, WALLET.

string,
mandatory

├─creditCard

Credit card data. To learn more see section Create Multipayment via Credit Card

object

├─boleto

Bank slip details used for payment. More information in the Create Multipayment by bank slip section.

object

├─onlineBankDebit

Bank transfer details used for payment. Visit the Create Multipayment by Online Debit. section.

object

└─wallet

~~ Electronic wallet data used for payment. Not available in this version of the API. ~~

object

cancellationDetails

Cancellation details of credit card payments.

structured

├─cancelledBy

Responsible for cancellation. Possible values: MOIP ou ACQUIRER.

string,
response

├─code

Cancellation reason code.
See list of payment cancellations details

integer,
response

└─description

Description of the reason for cancellation.

string,
response

updatedAt

Resource last update date.

datetime,
response

_links

Hypermedia link structure (HATEOAS) of the resource.

structured,
response

├─self

Hyperlink to the resource itself.

structured

├─└─href

Hyperlink to the resource itself.

link,
response

└─checkout

Links to checkout.

object,
response

_links

Hypermedia link structure (HATEOAS) of the resource.

structured,
response

├─self

Reference to the resource itself.

structured

├ └─href

Hyperlink to the resource itself.

link

├─order

Order reference.

structured

├ ├─title

Order identifier.

string

├ └─href

Hyperlink to the order.

link

└─payCheckout

Link structure.

structured

     └─redirectHref

URL to access the Wirecard checkout for the user to choose the payment method: bank slip, bank transfer or credit card.

link

└─payCreditCard

Link structure.

structured

     └─redirectHref

Wirecard checkout for credit card, safe and compliant environment by our PCI Compliance.

link

└─payBoleto

Link structure.

structured

     └─redirectHref

URL to access Wirecard checkout and print the bank slip.

link

└─payOnlineBankDebitItau

Link structure.

structured

     └─redirectHref

Automatic redirect URL to internet banking.

link

❗️

ATTENTION

In Multipayments there are some special situations. Pay attention to them:

  • If a payment on a shared cart is canceled, we cancel all of them;
  • If this payment is the first on a cart, we don't try process the others;
  • If that payment is the last in the cart, we cancel the previous ones.