POST /api/v2/payments
json
404 - Couldn't find a recipient record with that ID
422 - Request was correctly parsed but there is missing information
# Example URL http://www.bloomremit.net/api/v2/payments
# Example request { "api_token": "cKaB99a0", "api_secret": "t9spJmEu4", "payment" : { "account_name": "Luis Buenaventura", "account_number": "1234567890", "callback_url": "http://yourwebsite.com/callback_for_bloom", "dest_currency": "PHP", "flat_fee_in_orig_currency": 3000, "forex_margin": 0.5, "orig_currency": "KRW", "paid_in_orig_currency": 15000, "payout_method": "PLDT", "receivable_in_dest_currency": 500 } }
# Example 200 (successful) response { "payment": { "id": "fa672cc7-6006-46e6-9e64-14ac412cb2a4", "teller_id": "c2002ad1-7618-4592-b868-409ab209fdcf", "orig_currency": "KRW", "dest_currency": "PHP", "paid_in_orig_currency": 15000.0, "receivable_in_dest_currency": 500.0, "status": "incomplete", "payout_method": "PLDT", "partner_id": "049902b7-f09e-4675-a835-76df30017b94", "flat_fee_in_orig_currency": 3000.0, "forex_margin": 0.0, "account_name": "Luis Buenaventura", "account_number": "1234567890", "callback_url": "http://yourwebsite.com/callback_for_bloom", "sender_id": "d96f181e-d106-410d-86e0-2c91306dc97f" } }
# Example 422 (error) response when sender is not given { "errors": [ "Sender is blank" ] }
Name | Type | Description |
---|---|---|
api_token required | Value:
Must be a String |
Your API token |
api_secret required | Value:
Must be a String |
Your API secret |
sender_id required | Value:
Must be a String |
Sender ID that is paying for this bill |
payment required | Value:
Must be a Hash |
Remittance instructions |
payment[orig_currency] required | Value:
Must be one of: |
Currency of Origin (Ex. ‘USD’, ‘KRW’) |
payment[paid_in_orig_currency] required | Value:
Must be a Float |
Amount paid by customer (Ex. 20000.00) |
payment[flat_fee_in_orig_currency] optional | Value:
Must be a Float |
Flat service fee that you wish to add to the total bill of your sender. Leave this blank to use your default fee (if any). |
payment[forex_margin] optional | Value:
Must be a Float |
Additional foreign-exchange percentage to add to the total bill of your sender. Leave this blank to use your default margin (if any). |
payment[dest_currency] required | Value:
Must be one of: |
Currency of Destination |
payment[receivable_in_dest_currency] optional | Value:
Must be a Float |
Amount received by recipient (Ex. 1000.00). This is computed automatically and may be left blank |
payment[payout_method] required | Value:
Must be one of: |
Biller slug (Ex. PLDT) |
payment[account_name] required | Value:
Must be a String |
Account identifier with the biller (Ex. Phone number) |
payment[account_number] required | Value:
Must be a String |
Account number with the biller (Ex. Customer number) |
payment[callback_url] optional | Value:
Must be a 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. |
payment[external_id] required | Value:
Must be a String |
The ID that the bills payment service provider will track. Must be unique |