v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Retrieve Payment by Merchant Order ID

get/payments

Query parameters

merchant_order_idstring required

The unique identifier of the customer's order.

Response

200

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

Example response

[
  {
    "id": "e3f397ed-b7d0-4816-ab75-8457b0a30ec1",
    "account_id": "493e9374-510a-4201-9e09-de669d75f256",
    "description": "Test Bank of America",
    "country": "US",
    "status": "READY_TO_PAY",
    "sub_status": "CREATED",
    "merchant_order_id": "0000022",
    "created_at": "2023-07-20T17:24:58.900553Z",
    "updated_at": "2023-07-20T17:25:13.447662Z",
    "amount": {
      "currency": "USD",
      "value": 52000
    },
    "checkout": {
      "session": "954dc216-60ff-4ae4-a299-c603b93bd267",
      "sdk_action_required": true
    },
    "payment_method": {
      "type": "BANK_TRANSFER",
      "token": "2cd31999-e44e-4de3-bbe4-179981ff4295",
      "payment_method_detail": {
        "bank_transfer": {
          "bank_name": "Bank of America",
          "beneficiary_name": "John Doe",
          "bank_account": "123456789",
          "beneficiary_document_type": "SSN",
          "beneficiary_document": "123-45-6789",
          "redirect_url": "https://api-sandbox.wompi.co/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved"
        }
      }
    },
    "customer_payer": {
      "id": "cfae0941-7234-427a-a739-ef4fce966c79",
      "merchant_customer_id": "1689873883",
      "first_name": "John",
      "last_name": "Doe",
      "gender": "M",
      "date_of_birth": "1990-02-28",
      "email": "johndoe@example.com",
      "nationality": "US",
      "ip_address": "192.0.2.1",
      "document": {
        "document_type": "SSN",
        "document_number": "123-45-6789"
      },
      "phone": {
        "number": "5551234567",
        "country_code": "1"
      },
      "billing_address": {
        "address_line_1": "123 Main St",
        "address_line_2": "Apt 4B",
        "country": "US",
        "state": "California",
        "city": "Los Angeles",
        "zip_code": "90001"
      },
      "shipping_address": {
        "address_line_1": "123 Main St",
        "address_line_2": "Apt 4B",
        "country": "US",
        "state": "California",
        "city": "Los Angeles",
        "zip_code": "90001"
      }
    },
    "transactions": [
      {
        "id": "09135cb9-159c-4662-8fe3-da5523bb2266",
        "type": "PURCHASE",
        "status": "SUCCEEDED",
        "category": "BANK_TRANSFER",
        "amount": 52000,
        "provider_id": "BANK_OF_AMERICA",
        "payment_method": {
          "type": "BANK_TRANSFER",
          "token": "2cd31999-e44e-4de3-bbe4-179981ff4295",
          "detail": {
            "bank_transfer": {
              "bank_name": "Bank of America",
              "beneficiary_name": "John Doe",
              "bank_account": "123456789",
              "beneficiary_document_type": "SSN",
              "beneficiary_document": "123-45-6789",
              "redirect_url": "https://api-sandbox.wompi.co/v1/payment_methods/redirect/bank_transfer?transferCode=52xB9jF695TdDvHK-approved"
            }
          }
        },
        "response_code": "SUCCEEDED",
        "response_message": "Transaction successful",
        "description": "Test Bank of America",
        "provider_data": {
          "id": "BANK_OF_AMERICA",
          "transaction_id": "117490-1689873907-17347",
          "status": "APPROVED",
          "iso8583_response_code": "00",
          "iso8583_response_message": "Approved or completed successfully",
          "raw_response": {
            "data": {
              "amount_in_cents": 5200000,
              "created_at": "2023-07-20T17:25:07.167Z",
              "currency": "USD",
              "customer_email": "johndoe@example.com",
              "id": "117490-1689873907-17347",
              "payment_method": {
                "payment_description": "Test Bank of America",
                "sandbox_status": "APPROVED",
                "type": "BANK_TRANSFER",
                "user_type": "PERSON"
              },
              "payment_method_type": "BANK_TRANSFER",
              "redirect_url": "https://google.com/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267",
              "reference": "09135cb9-159c-4662-8fe3-da5523bb2266",
              "status": "PENDING"
            }
          }
        },
        "created_at": "2023-07-20T17:25:05.410687Z",
        "updated_at": "2023-07-20T17:25:11.472652Z"
      }
    ],
    "callback_url": "https://y.uno/?checkoutSession=954dc216-60ff-4ae4-a299-c603b93bd267",
    "workflow": "SDK_CHECKOUT"
  }
]