Payment status

cURL

# Ask for the payment by YOUR reference, or by checkoutId. A 404 whose "error" is "Transaction not found" means there
# is no such payment. Any other 404 means the address itself was refused: check the reference, do not create again.
antpay_get_by_reference() { antpay_call GET "/api/v1/transactions/$(antpay_urlencode "$1")"; }
antpay_get_checkout()     { antpay_call GET "/api/v1/checkouts/$(antpay_urlencode "$1")"; }

Part of antpay.sh, the complete tested file

Node.js

// Ask for the payment by YOUR reference. Use it after an unclear create, and as a fallback to the postback.
// Returns null ONLY when the API itself says there is no such payment. Any other 404 means the address was refused
// (a wrong path, or a reference with characters that cannot travel in a URL): that is an error, not "no payment".
async function getByReference(reference) {
  const { http: status, json } = await call('GET', '/api/v1/transactions/' + encodeURIComponent(reference));
  if (status === 200 && json && json.success) return json.transaction;     // .status is pending | completed | failed
  if (status === 404 && json && json.error === 'Transaction not found') return null;
  throw new Error(`status call failed (HTTP ${status}${json && json.error ? ', ' + JSON.stringify(json.error) : ''})`);
}

async function getCheckout(checkoutId) {
  const { http: status, json } = await call('GET', '/api/v1/checkouts/' + encodeURIComponent(checkoutId));
  if (status === 200 && json && json.success) return json.checkout;
  if (status === 404 && json && json.error === 'Checkout session not found') return null;
  throw new Error(`status call failed (HTTP ${status}${json && json.error ? ', ' + JSON.stringify(json.error) : ''})`);
}

Part of antpay.js, the complete tested file

PHP

// Ask for the payment by YOUR reference. Use it after an unclear create, and as a fallback to the postback.
// Returns null ONLY when the API itself says there is no such payment. Any other 404 means the address was refused
// (a wrong path, or a reference with characters that cannot travel in a URL): that is an error, not "no payment".
function antpay_get_by_reference(string $reference): ?array {
    [$status, $data] = antpay_call('GET', '/api/v1/transactions/' . rawurlencode($reference));
    if ($status === 200 && is_array($data) && !empty($data['success'])) return $data['transaction'];   // ['status'] is pending | completed | failed
    if ($status === 404 && is_array($data) && ($data['error'] ?? null) === 'Transaction not found') return null;
    throw new RuntimeException("status call failed (HTTP $status, " . json_encode($data['error'] ?? null) . ')');
}

function antpay_get_checkout(string $checkoutId): ?array {
    [$status, $data] = antpay_call('GET', '/api/v1/checkouts/' . rawurlencode($checkoutId));
    if ($status === 200 && is_array($data) && !empty($data['success'])) return $data['checkout'];
    if ($status === 404 && is_array($data) && ($data['error'] ?? null) === 'Checkout session not found') return null;
    throw new RuntimeException("status call failed (HTTP $status, " . json_encode($data['error'] ?? null) . ')');
}

Part of antpay.php, the complete tested file

Python

# Ask for the payment by YOUR reference. Use it after an unclear create, and as a fallback to the postback.
# Returns None ONLY when the API itself says there is no such payment. Any other 404 means the address was refused
# (a wrong path, or a reference with characters that cannot travel in a URL): that is an error, not "no payment".
def get_by_reference(reference):
    status, data = call("GET", "/api/v1/transactions/" + urllib.parse.quote(reference, safe=""))
    if status == 200 and data and data.get("success"):
        return data["transaction"]          # ["status"] is pending | completed | failed
    if status == 404 and data and data.get("error") == "Transaction not found":
        return None
    raise RuntimeError(f"status call failed (HTTP {status}, {data.get('error') if data else None})")


def get_checkout(checkout_id):
    status, data = call("GET", "/api/v1/checkouts/" + urllib.parse.quote(checkout_id, safe=""))
    if status == 200 and data and data.get("success"):
        return data["checkout"]
    if status == 404 and data and data.get("error") == "Checkout session not found":
        return None
    raise RuntimeError(f"status call failed (HTTP {status}, {data.get('error') if data else None})")

Part of antpay.py, the complete tested file