Skip to navigation

Simulate execution of a Bank Wire PayIn

Note – Sandbox only

This endpoint is only available in the Sandbox environment, to simulate real-world bank wire payment.

Simulates the acceptance or rejection of an existing pre-declared bank wire pay-in (with PaymentType of BANK_WIRE and ExecutionType of DIRECT).

This call changes the pay-in’s Status from CREATED to:

  • SUCCEEDED, if ACCEPT is sent, and the pay-in amount is credited to the wallet. This simulates the arrival of funds on Mangopay’s bank account and successful reconciliation.
  • FAILED, if REJECT is sent, with the ResultCode 008500. This simulates the rejection of the funds for anti-fraud reasons.

The PayInId must exist in Sandbox, have the Status of CREATED, and have an Id beginning with the prefix payin_wf_ — pay-ins created before this endpoint’s release use a different prefix and aren’t supported. If the PayInId is not found, then a 404 response is returned.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
PayInIdstringRequired

The unique identifier of the bank wire pay-in to simulate, which must:

  • Exist in the Sandbox environment.
  • Have the Status of CREATED.
  • Have an Id beginning with the prefix payin_wf_. Pay-ins created before this endpoint’s release have a different prefix and are not supported.

Request

This endpoint expects an object.
ActionstringRequired

Allowed values: ACCEPT, REJECT

  • ACCEPT – Simulates the arrival of funds on Mangopay’s bank account and successful reconciliation, crediting the wallet with the pay-in amount and transitioning the pay-in’s Status to SUCCEEDED.
  • REJECT – Simulates the pay-in being refused for anti-fraud reasons, transitioning the pay-in’s Status to FAILED with the ResultCode 008500.

Response

Success

Errors

404
Not Found Error