SimPayDocs

    Get MED Details

    Retrieves comprehensive details for a specific MED, including account information, bank details, QR code information, analysis data, and chargeback history.

    GEThttps://api.somossimpay.com.br/v3/meds/{med_id}
    curl --request GET \
      --url 'https://api.somossimpay.com.br/v3/meds/{med_id}' \
      --header 'Authorization: Bearer <ACCESS_TOKEN>'
    Response200
    {
      "pix_med_id": "med-123-abc-def",
      "e2e": "E1234567820240115143000123",
      "amount": 1000.5,
      "transaction_date": "2024-01-15T14:30:00Z",
      "reason": "RETURN_REQUEST",
      "status": "ACCEPTED_BY_PSP",
      "infraction_report_id": "report-456",
      "infraction_report_status": "ANALYZED",
      "origin_situation_type": "SCAM_FRAUD",
      "details": "Detailed description of the dispute",
      "payer_name": "João Silva",
      "payer_document": "12345678901",
      "debited": {
        "ispb": "12345678",
        "bank": "Banco Example",
        "agency": "1234",
        "account": "567890",
        "document": "12345678901",
        "name": "João Silva"
      },
      "credited": {
        "ispb": "35535240",
        "bank": "Example Bank",
        "agency": "0001",
        "account": "123456",
        "document": "98765432000123",
        "name": "Company Name"
      },
      "qrcode_details": {
        "qr_code_id": 123,
        "tx_id": "tx-456",
        "pix_type": "DYNAMIC",
        "status": "PAID",
        "key": "user@example.com",
        "expiration_date": "2024-01-15T23:59:59Z",
        "due_date": "2024-01-15T23:59:59Z",
        "copy_and_paste": "00020126580014...",
        "payment_date": "2024-01-15T14:30:00Z",
        "created_at": "2024-01-15T10:00:00Z"
      },
      "analysis": {
        "analysis_result": "ACCEPTED",
        "analysis_details_user": "User analysis details",
        "analysis_details_psp": "PSP confirmed fraudulent transaction",
        "internal_notes": null,
        "user_analyzed_by": "Ana Costa",
        "psp_analyzed_by": "Carlos Silva"
      },
      "chargebacks": [
        {
          "status": "SUCCESS",
          "info_text": "Chargeback successful",
          "error_descriptor": null,
          "amount": 1000.5,
          "created_at": "2024-01-16T10:00:00Z",
          "updated_at": "2024-01-16T10:30:00Z"
        }
      ],
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-16T10:30:00Z"
    }

    MED Details Endpoint

    GET /v3/meds/{med_id}

    Retrieves comprehensive details for a specific MED, including account information, bank details, QR code information, analysis data, and chargeback history.

    Authentication

    HeaderTypeRequiredExample
    AuthorizationStringYesBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

    Path Parameters

    ParameterTypeRequiredDescription
    med_idStringYesUnique identifier of the MED to retrieve

    Response (200 OK)

    {
      "pix_med_id": "med-123-abc-def",
      "e2e": "E1234567820240115143000123",
      "amount": 1000.50,
      "transaction_date": "2024-01-15T14:30:00Z",
      "reason": "RETURN_REQUEST",
      "status": "ACCEPTED_BY_PSP",
      "infraction_report_id": "report-456",
      "infraction_report_status": "ANALYZED",
      "origin_situation_type": "SCAM_FRAUD",
      "details": "Detailed description of the dispute",
      "payer_name": "João Silva",
      "payer_document": "12345678901",
      "debited": {
        "ispb": "12345678",
        "bank": "Banco Example",
        "agency": "1234",
        "account": "567890",
        "document": "12345678901",
        "name": "João Silva"
      },
      "credited": {
        "ispb": "35535240",
        "bank": "Example Bank",
        "agency": "0001",
        "account": "123456",
        "document": "98765432000123",
        "name": "Company Name"
      },
      "qrcode_details": {
        "qr_code_id": 123,
        "tx_id": "tx-456",
        "pix_type": "DYNAMIC",
        "status": "PAID",
        "key": "user@example.com",
        "expiration_date": "2024-01-15T23:59:59Z",
        "due_date": "2024-01-15T23:59:59Z",
        "copy_and_paste": "00020126580014...",
        "payment_date": "2024-01-15T14:30:00Z",
        "created_at": "2024-01-15T10:00:00Z"
      },
      "analysis": {
        "analysis_result": "ACCEPTED",
        "analysis_details_user": "User analysis details",
        "analysis_details_psp": "PSP confirmed fraudulent transaction",
        "internal_notes": null,
        "user_analyzed_by": "Ana Costa",
        "psp_analyzed_by": "Carlos Silva"
      },
      "chargebacks": [
        {
          "status": "SUCCESS",
          "info_text": "Chargeback successful",
          "error_descriptor": null,
          "amount": 1000.50,
          "created_at": "2024-01-16T10:00:00Z",
          "updated_at": "2024-01-16T10:30:00Z"
        }
      ],
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-16T10:30:00Z"
    }

    Response Fields

    Main Fields

    FieldTypeDescription
    pix_med_idStringUnique MED identifier
    e2eStringEnd-to-end transaction identifier
    amountDecimalDisputed amount
    transaction_dateDatetimeWhen the transaction occurred
    reasonStringRETURN_REQUEST or RETURN_CANCELLATION
    statusStringCurrent MED status
    infraction_report_idStringInfraction report identifier
    infraction_report_statusStringOPEN, RECEIVED, ANALYZED, or CANCELLED
    origin_situation_typeStringType of fraud situation
    detailsStringDispute description
    payer_nameStringName of the payer
    payer_documentStringCPF/CNPJ of the payer

    Account Information (debited/credited)

    FieldTypeDescription
    ispbStringBank's ISPB code
    bankStringBank name
    agencyStringBank agency code
    accountStringAccount number
    documentStringAccount holder document
    nameStringAccount holder name

    QR Code Details

    FieldTypeDescription
    qr_code_idIntegerQR Code unique identifier
    tx_idStringTransaction ID
    pix_typeEnumSTATIC or DYNAMIC
    statusEnumQR Code status
    keyStringPIX key used
    expiration_dateDatetimeQR Code expiration
    due_dateDatetimePayment due date
    copy_and_pasteStringQR Code string
    payment_dateDatetimeWhen payment was made
    created_atDatetimeQR Code creation date

    Analysis Information

    FieldTypeDescription
    analysis_resultEnumACCEPTED or REJECTED
    analysis_details_userStringUser analysis details
    analysis_details_pspStringPSP analysis details
    internal_notesStringInternal notes (currently not used)
    user_analyzed_byStringName of user who analyzed
    psp_analyzed_byStringName of PSP analyst

    Chargeback History

    FieldTypeDescription
    statusEnumPENDING, SUCCESS, or REJECTED
    info_textStringAdditional information
    error_descriptorStringError description if failed
    amountDecimalChargeback amount
    created_atDatetimeChargeback creation date
    updated_atDatetimeLast update date

    Usage Examples

    cURL

    curl --request GET \
      --url https://api.somossimpay.com.br/v3/meds/med-123-abc-def \
      --header 'Accept: application/json' \
      --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

    Error Responses

    404 Not Found

    {
      "detail": "MED not found"
    }

    401 Unauthorized

    {
      "detail": "Invalid authentication credentials"
    }