Payment status processing

After the connector creates a payment in Hyperwallet, Hyperwallet starts processing it. The payment goes through some intermediate states until it reaches a final success or failure state.

Payment status processing isn’t started by the connector using jobs. Hyperwallet servers are the ones notifying the progress of the payment to the connector. The connector then sets the invoice to paid if the payment was successful or sends an error mail if there was a problem.

Characteristics

  • The connector makes use of the webhooks functionality provided by Hyperwallet.

  • The connector sends error mails when a payment isn’t successful.

Payment status processing process

paymentstatus-process

Hyperwallet events

The connector processes the following events associated to Hyperwallet’s user type:

Event Relevant fields

PAYMENTS.UPDATED.STATUS.*

  • token

  • type

  • createdOn

  • object.token

  • object.clientPaymentId

  • object.status

The following is the list of PAYMENTS.UPDATED.STATUS.* statuses:

Successful statuses Failure statuses In progress statuses

  • COMPLETED

  • FAILED

  • RECALLED

  • RETURNED

  • EXPIRED

  • UNCLAIMED

  • CANCELLED

  • CREATED

  • SCHEDULED

  • PENDING_ACCOUNT_ACTIVATION

  • PENDING_TAX_VERIFICATION

  • PENDING_TRANSFER_METHOD_ACTION

  • PENDING_TRANSACTION_VERIFICATION

The connector marks the invoice as PAID for successhful statuses, sends an error for failure ones and ignores in progress statuses.

Hyperwallet documentation provides more information about the Hyperwallet user events.

API calls

The connector does the following API calls during the sellers extraction jobs execution:

Call Target System Endpoint Parameters

Confirms the payment of an invoice setting its status to PAID.

Mirakl

PUT IV07 - Confirm the payment of accounting documents

  • invoice_id: invoice identifier

  • currency_iso_code: ISO code for the currency used in the payment.

  • amount: Amount of the invoice.

  • transaction_date: Invoice transaction date.

  • confirm_all_linked_manual_documents: Confirm the payment of each manual accounting document present in the billing cycle.

Data mapping

The following is the mapping between the Hyperwallet payment status notification and the Mirakl invoice confirmation request.

Hyperwallet field Mirakl field

amount

amount

currency

currency_iso_code

clientPaymentId

invoice_id

createdOn

transaction_date