Skip to main content
POST
Send an action to the Bango Platform

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

nsid
string<uuid>
required

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.

Example:

"673c74de-ce5b-4f79-9851-2544d1d836cb"

Body

application/json

An action initiated by the payment provider, to be processed by the Bango Platform.

The following action types are available. See each action type schema for detailed information on purpose and response action types.

  • SEND_MERCHANT_MESSAGE: Ask the Bango Platform to forward a message from the payment provider to a merchant partner
  • GET_SESSION: Ask the Bango Platform for the data stored for a verification session
  • CONFIRM_SESSION_IDENTITY: Notify the Bango Platform that an end user was successfully identified as part of an identity verification flow
  • REJECT_SESSION_IDENTITY: Notify the Bango Platform that an end user was NOT successfully identified as part of an identity verification flow
  • CANCEL_PI: Ask the Bango Platform to permanently cancel a payment instrument and any associated payment instrument tokens
  • UPDATE_SESSION: Ask the Bango Platform to store data with a verification session, including data shared with the merchant partner
  • GET_PI: Ask the Bango Platform for the data stored for a payment instrument
  • UPDATE_PI: Ask the Bango Platform to update the data stored for a payment instrument
  • NOTIFY_MO: Provide the Bango Platform with details of an MO message received by the payment provider

This action might be replaced in a future phase of work

This action type lets a payment provider ask the Bango Platform to forward a message intact from the payment provider to a merchant partner.

The action identifies the merchant partner using a string ID defined by Bango Support as part of the payment provider's configuration settings (different payment providers may use different strings for the same merchant partner).

The action includes the message body and a message type. The Bango Platform uses the message type to select how to forward the message to the merchant partner. For example, some merchant partners may reserve different API endpoints for the delivery of different types of message. Not all merchant partners may support all message types.

Possible HTTP responses

  • HTTP 204 NO CONTENT:
    • the message was successfully sent to the merchant partner
  • HTTP 400 BAD REQUEST with one or more errors:
    • code == invalid-json:
      • the request body is not valid JSON
    • code == missing-parameter:
      • a required parameter is omitted from the request action
    • code == invalid-parameter:
      • a parameter is not of the expected type, or
      • a parameter violates the documented constraints, or
      • payload.recipientId is not recognized as a merchant partner the payment provider may contact, or
      • payload.recipientId is recognized as a merchant partner but it doesn't support the message type, or
      • payload.recipientId is recognized as a merchant partner but it rejected the message (the error's meta object may give a reason)
id
string<uuid>
required

A unique identifier for the request action (not used for any other purpose). If the recipient of the request action returns a response action, the response action must specify the same identifier as its own id.

Example:

"2adf1639-bb50-4df7-b8a0-79a0cd4f2277"

type
any
required
payload
object
required

Response

The response action, which depends on the request action.

The data stored for a verification session in the Bango Platform. Includes private data, data the payment provider has provided to the merchant, and data the merchant has provided to the payment provider.

id
string<uuid>
required

The unique identifier for the request action to which this is a response.

Example:

"2adf1639-bb50-4df7-b8a0-79a0cd4f2277"

type
any
required
payload
object
required