Retrieve information about an identity token
Use this endpoint to retrieve information about an identity token.
This contains cached eligibility information that might be out of date. To fetch the latest information, send the FETCH_ELIGIBILITY action to the resource (response time will increase, as the Bango Platform fetches the latest information from the downstream payment provider).
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Globally unique namespace ID. These IDs are opaque, not guessable, and not sequential.
Bango provides each Bango partner with a unique set of resource URIs. All resource URI paths start with /ns/{nsid}, where {nsid} is the namespace ID. No other Bango partner shares this namespace. Partner credentials permit access only to URIs with this namespace.
"673c74de-ce5b-4f79-9851-2544d1d836cb"
Globally unique resource ID. These IDs are opaque, not guessable, and not sequential.
Each individual resource in a partner's namespace has a unique identifier: this is the identifier immediately after the resource type in the URI path.
For example, in the URI /ns/673c74de-ce5b-4f79-9851-2544d1d836cb/elephants/581b2e40-741c-4683-ae66-46c9fe6f4d5e:
- The namespace id is
673c74de-ce5b-4f79-9851-2544d1d836cbde elephantsindicates the resource type iselephant- The resource id is
581b2e40-741c-4683-ae66-46c9fe6f4d5e
Every resource has a read-only property rid that contains the resource ID, for convenience.
"581b2e40-741c-4683-ae66-46c9fe6f4d5e"
Response
Resource found
Globally unique resource ID. These IDs are opaque, not guessable, and not sequential.
Each individual resource in a partner's namespace has a unique identifier: this is the identifier immediately after the resource type in the URI path.
For example, in the URI /ns/673c74de-ce5b-4f79-9851-2544d1d836cb/elephants/581b2e40-741c-4683-ae66-46c9fe6f4d5e:
- The namespace id is
673c74de-ce5b-4f79-9851-2544d1d836cbde elephantsindicates the resource type iselephant- The resource id is
581b2e40-741c-4683-ae66-46c9fe6f4d5e
Every resource has a read-only property rid that contains the resource ID, for convenience.
"581b2e40-741c-4683-ae66-46c9fe6f4d5e"
RFC 3339 datetime of the last update to this resource
"2022-12-21T08:59:32Z"
The type of token. Code can use type to infer the schema for the rest of the resource.
For now, only payment-instrument-token is supported. Other values may be supported in future.
The token state. Tokens of type payment-instrument-token are always one of:
active: may be used for payments, if eligiblecanceled: may not be used for payments
The only permitted state transition is from active to canceled. To make this transition, send a CANCEL action. It is not possible to transition from canceled back to active.
active, canceled Friendly unique identifier for the merchant partner.
Internally, corresponds to the accountKey property in the route-config-server's partner_namespaces table.
2 - 50"AUSSIE_APPS"
Friendly unique identifier for the payment provider.
Internally, corresponds to the accountKey property in the route-config-server's partner_namespaces table.
2 - 50"OGNABTEL"
Information about the token related to payment processing.
discovering: The Bango Platform is currently waiting for a response from the payment provider about the tokenenabled: Authorized partners can use the token to process paymentsnot-enabled: The payment provider has not enabled the token to process paymentsclosed: The payment provider has decided the token can no longer process payments (this is permanent)barred: The payment provider has suspended or barred the user associated with the token (this may be temporary)unknown: The payment provider has not provided information about this tokenunsupported: The payment provider does not support requests for information about this token
discovering, enabled, not-enabled, closed, barred, unknown, unsupported The account type allocated by the payment provider for an end user's account.
prepaid, postpaid, unknown Customer’s latest spending limit profile
Properties that are specific to a user

