Txns


Initiate a txn. May be a remittance or a bill payment

POST /api/v3/txns

Supported Formats

json

Errors

404 - Couldn't find a sender record with that ID
422 - Request was correctly parsed but there is missing information

Examples

# Example request

POST http://www.bloomremit.net/api/v3/txns

{
  "api_token": "cKaB99a0",
  "api_secret": "t9spJmEu4",
  "sender_id": "05d6addf-fc27-4e78-bc29-92c9dda1560b",
  "txn": {
    "amount": 500,
    "target_slug": "PLDT",
    "account_name": "Luis Buenaventura",
    "account_number": "1234567890",
    "callback_url": "http://yourwebsite.com/callback_for_bloom",
    "recipient_id": "6d5782ba-e7fc-4c7f-8c32-89df7c03859e",
    "client_external_id": "ASAJDIWJCNEB"
  }
}
# Example 200 (successful) response
{
  "txn": {
    "id": "fa672cc7-6006-46e6-9e64-14ac412cb2a4",
    "amount": 500,
    "currency": "PHP",
    "status": "incomplete",
    "target_slug": "PLDT",
    "account_name": "Luis Buenaventura",
    "account_number": "1234567890",
    "callback_url": "http://yourwebsite.com/callback_for_bloom",
    "recipient_id": "6d5782ba-e7fc-4c7f-8c32-89df7c03859e",
    "client_external_id": "ASAJDIWJCNEB"
  }
}
# Example 422 (error) response when sender is not given
{
  "errors": [ "Sender is blank" ]
}

Request Parameters

NameTypeDescription
api_token
required
Value:

Must be String

Your API token

api_secret
required
Value:

Must be String

Your API secret

sender_id
required
Value:

Must be String

Sender ID that is sending the transaction

teller_id
optional
Value:

Must be String

Teller ID that is logging the transaction

txn
required
Value:

Must be a Hash

txn[amount]
optional
Value:

Must be Float

Amount received by recipient (Ex. 1000.00). This is computed automatically and may be left blank

txn[target_slug]
required
Value:

Must be String

Must be a biller slug or a deposit strategy slug

txn[account_name]
required
Value:

Must be String

Account identifier with the biller (Ex. Phone number)

txn[account_number]
required
Value:

Must be String

Account number with the biller (Ex. Customer number)

txn[callback_url]
optional
Value:

Must be String

URL to post updates to when the status of a remittance changes. Please respond with a HTTP Code 200 and the word ‘ok’. If you have a Callback URL already defined in the Partner Settings, this is unnecessary.

txn[recipient_id]
optional
Value:

Must be String

Recipient’s id (leave blank if payment)

txn[client_external_id]
required
Value:

Must be String

A unique identifier. This is mainly used to mitigate bugs where multiple API calls are made with the same client_external_id.