payins

View a PayIn

Changed on
<Note icon="fa-regular fa-circle-info"> **Note – Pay-in data retained for 13 months**

An API call to retrieve a pay-in whose CreationDate is older than 13 months may return 404 Not Found.

For more information, see the <a href="/api-reference/overview/data-availability-periods">Data availability periods</a> article. </Note>

Retrieve any pay-in by its Id. The object returned depends on the endpoint that was used to create it. The difference is indicated by the PaymentType, ExecutionType, and in some cases other properties.

get/v2.01/{ClientId}/payins/{PayInId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/{PayInId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

PayInIdstring required

The unique identifier of the pay-in.

Response

Success

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

  • 33a23ba84cddRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      removed from the response body oneOf list for the response status

  • f44a59c76515Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API