QR Slip Verification API

The QR Slip Verification API confirms a bank transfer payment from the slip your shopper sends you, for payments made on Beam.

The following operation is available:

• Verify Charge with QR Slip (POST /api/v1/charges/verify-qr-slip): match a slip against your charges and update the matching charge to SUCCEEDED if it is still PENDING.

For the concepts behind this endpoint, see QR Slip Verification. For the full schema, see the API reference.

Verify a charge with a QR slip

The request uses multipart/form-data. The format field tells Beam which other field carries the QR code:

Verify with the raw QR code content

Set format=RAW and put the raw content of the QR code in the raw field:

POST https://api.beamcheckout.com/api/v1/charges/verify-qr-slip
Authorization: Basic <base64(merchantId:apiKey)>
Content-Type: multipart/form-data; boundary=WebAppBoundary
 
--WebAppBoundary
Content-Disposition: form-data; name="format"
 
RAW
--WebAppBoundary
Content-Disposition: form-data; name="raw"
 
0041000600000101030040220015077082818AQR086795102TH9104FF93
--WebAppBoundary--

Verify with the slip image

Set format=IMAGE and put the slip image in the image field:

POST https://api.beamcheckout.com/api/v1/charges/verify-qr-slip
Authorization: Basic <base64(merchantId:apiKey)>
Content-Type: multipart/form-data; boundary=WebAppBoundary
 
--WebAppBoundary
Content-Disposition: form-data; name="format"
 
IMAGE
--WebAppBoundary
Content-Disposition: form-data; name="image"; filename="example-slip.png"
 
< example-slip.png
--WebAppBoundary--

Handle the verification response

A 200 means the slip matched one of your charges and that charge is now SUCCEEDED. The body carries the chargeId of the matched charge and the verificationResult of the check:

{
  "chargeId": "ch_2xTsz7Qit55pahSvKfJG3UMkpFQ",
  "verificationResult": "UPDATED_TO_SUCCEEDED"
}

Read verificationResult when you need to know which case happened. This is also what makes retries safe. If you send the same slip again, the second call returns 200 with the same chargeId and ALREADY_SUCCEEDED.

When Beam updates a charge to SUCCEEDED, we also sends the related webhooks, such as charge.succeeded. These are the same events you get when a charge succeeds in any other way. See Event Types for the payloads.

Errors

When Beam cannot verify the slip, it returns a standard error response and no charge changes:

For example, when no charge matches the slip:

{
  "code": 404,
  "message": "not found",
  "error": {
    "errorCode": "NOT_FOUND_ERROR",
    "errorMessage": "not found"
  }
}

Testing on Playground

Beam matches a slip against a charge that the shopper paid by bank transfer, and that transfer has to be real. Playground has no real bank transfers, so you cannot test the success case there. What you can test is whether Beam accepts the slip or the QR code content you send, which covers the rest of your integration.

Send your test requests to https://playground.api.beamcheckout.com/api/v1/charges/verify-qr-slip with your Playground API key: