YOyoco
Web POS

Fetch a Web POS payment

Changed on

Fetch a Web POS payment.

Required scope: business/webpos:read

get/v1/webpos/{webpos_device_id}/payments/{payment_id}

Request

  • Base URL
    https://api.yoco.com
  • Auth
    HTTP bearer

Path parameters

webpos_device_idstring uuid required
payment_idstring uuid required

Response

Successful Response

idstring uuid required

The unique ID for the Web POS payment. Can be used to fetch Web POS payment.

status'failed' | 'pending' | 'successful' required
redirect_urlstring required

The URL that can be loaded into an iFrame, window, or new tab to accept merchant input via their browser. The loaded web application can be used by the merchant to confirm the payment session and monitor its progress.

webpos_device_idstring uuid required

The Web POS Device which created the payment.

client_referencestring required

The reference value provided by the host POS when the Web POS payment was created.

created_atstring date-time required

The date and time the Web POS payment was created, in ISO 8601 format.

updated_atstring date-time required

The date and time the Web POS payment was last updated, in ISO 8601 format.

metadataobject nullable

The metadata provided by the host POS when the Web POS payment was created.

Example response

{
  "amount": {
    "amount": 200,
    "currency": "ZAR"
  },
  "client_reference": "af4a8c17-5720-4a8b-aab1-4619667eaa02",
  "created_at": "2024-10-31T07:53:29.187Z",
  "id": "9c07e0aa-327d-4d41-a8f0-f2136aa22ff8",
  "metadata": {
    "foo": "bar"
  },
  "payment_details": {
    "authorization_id": "004681",
    "card_details": {
      "cardholder_verification_method": "online_pin",
      "masked_pan": "441595******4874",
      "pan_entry_mode": "contactless_icc",
      "scheme": "visa"
    },
    "emv_application_info": {
      "application_identifier": "A0000000031010",
      "application_name": "VISA DEBIT"
    },
    "retrieval_reference_number": "061038691660"
  },
  "redirect_url": "https://cpw.yoco.com/redirect/payments/9c07e0aa-327d-4d41-a8f0-f2136aa22ff8",
  "status": "successful",
  "terminal": {
    "model": "Neo Touch",
    "serial_number": "52303251110"
  },
  "updated_at": "2024-10-31T07:55:12.984Z",
  "webpos_device_id": "4cf28172-3bf5-48cd-8c55-e83e1a976992"
}

Changes

  • daf9b9d86161Revision changes
    • info

      added the non-success response with the status

  • 47cea4404cf5Revision changes
    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status