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 |
|---|---|---|
| Wirecard multipayment id. | string(16), |
| Multipayment statuses. Possible values: | string, |
| Multipayment values. | structured |
├─ | Currency used for payment. Possible values: | string, |
└─ | The total amount of multipayment. In cents . Ex: R$10.32 will be informed | integer(12), |
| Installments number. Minimum | integer(2) |
| Whether payment must be pre-authorized for later capture. Valid only for payments by credit card. | boolean |
| Payment method structure. | structured |
├─ | Payment method. Possible values: | string, |
├─ | Credit card data. To learn more see section Create Multipayment via Credit Card | object |
├─ | Bank slip details used for payment. More information in the Create Multipayment by bank slip section. | object |
├─ | Bank transfer details used for payment. Visit the Create Multipayment by Online Debit. section. | object |
| ~~ Electronic wallet data used for payment. Not available in this version of the API. ~~ |
|
| Cancellation details of credit card payments. | structured |
├─ | Responsible for cancellation. Possible values: | string, |
├─ | Cancellation reason code. | integer, |
└─ | Description of the reason for cancellation. | string, |
| Resource last update date. | datetime, |
| Hypermedia link structure (HATEOAS) of the resource. | structured, |
├─ | Hyperlink to the resource itself. | structured |
├─└─ | Hyperlink to the resource itself. | link, |
└─ | Links to checkout. | object, |
| Hypermedia link structure (HATEOAS) of the resource. | structured, |
├─ | Reference to the resource itself. | structured |
├ └─ | Hyperlink to the resource itself. | link |
├─ | Order reference. | structured |
├ ├─ | Order identifier. | string |
├ └─ | Hyperlink to the order. | link |
└─ | Link structure. | structured |
└─ | URL to access the Wirecard checkout for the user to choose the payment method: bank slip, bank transfer or credit card. | link |
└─ | Link structure. | structured |
└─ | Wirecard checkout for credit card, safe and compliant environment by our PCI Compliance. | link |
└─ | Link structure. | structured |
└─ | URL to access Wirecard checkout and print the bank slip. | link |
└─ | Link structure. | structured |
└─ | 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.