BillKit/DocsConsole
Payments

Get payment provider payload

Fetch the payment provider's own record of this payment, live.

GET/v1/payments/{payment_id}/provider
Operation get_payment_provider_payload·Scope payments:read·OpenAPI v1.1.0

Parameters

ParameterDescription
payment_idstring · pathrequiredId of the payment, which starts pay_.

Returns

Returns a ProviderPayloadResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the payments:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/payments/pay_9XKp2vQ1/provider \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "available": false,
  "object": "payment.provider_payload",
  "payload": {
    "key": "value"
  },
  "provider": "string",
  "provider_payment_id": "provider_payment_9XKp2vQ1",
  "redacted": false,
  "unavailable_reason": "string"
}