Welcome to the official API of Rebit.ph. To start using the API, retrieve your API token at the Developer Dashboard. Please see /developers for general information about the API, and direct your inquiries to admin@rebit.ph. Don't forget: All API calls must include ?token=API_TOKEN in their provided parameters.

Resources

Recipients

Resource Description
POST /api/v1/recipients USERS: Create a new recipient. START HERE when initiating a new money transfer.
GET /api/v1/recipients USERS: List all recipients
GET /api/v1/recipients/:id USERS: Show details about a recipient and their associated remittance(s)
PUT /api/v1/recipients/:id USERS: Update recipient attributes
DELETE /api/v1/recipients/:id USERS: Delete recipient record safely

Remittances

Resource Description
POST /api/v1/remittances USERS: Initiate a new money transfer by providing a recipient_id and a remittance hash
GET /api/v1/remittances/:id USERS: Show information about a given recipient along with their associated remittance
DELETE /api/v1/remittances/:id USERS: Cancel a remittance. Note that this only changes the status of the remittance but does not delete it from the database.
POST /api/v1/remittances/calculate Returns the processing fee and service fee for a given remittance amount, strategy, and province.

Static

Resource Description
GET /api/v1/rates UNAUTHENTICATED: Returns a real-time hash of currency exchange rates. Updates every 1 minute.
GET /api/v1/schedule UNAUTHENTICATED: Returns a hash regarding our current fulfillment capabilities.
GET /api/v1/strategies UNAUTHENTICATED: Lists Remittance Strategies
GET /api/v1/provinces UNAUTHENTICATED: Lists Philippine provinces alphabetically
GET /api/v1/provinces_by_region UNAUTHENTICATED: Lists Philippine provinces by region

Users

Resource Description
GET /api/v1/user USERS: Show information and associated recipient and remittance ids of the current user
PUT /api/v1/user USERS: Update user attributes

Vendor credits

Resource Description
GET /api/v1/vendors/:vendor_api_token/credits/:id VENDORS: Retrieve a credit address, its rate, and effectivity
POST /api/v1/vendors/:vendor_api_token/credits VENDORS: Create a new address and get a new rate
GET /api/v1/vendors/:vendor_api_token/credits VENDORS: Show a list of credit transactions

Vendor outgoing remittances

Resource Description
GET /api/v1/vendors/:vendor_api_token/users/:user_id/outgoing_remittances VENDORS: Show all outgoing-remittances belonging to the given user. Only available for users of type 'BUSINESS USER'

Vendor recipients

Resource Description
POST /api/v1/vendors/:vendor_api_token/users/:user_id/recipients VENDORS: Create a new recipient for a user belonging to a VENDOR partner.
GET /api/v1/vendors/:vendor_api_token/users/:user_id/recipients VENDORS: List all recipients for a user belonging to a VENDOR partner.
GET /api/v1/vendors/:vendor_api_token/users/:user_id/recipients/:id VENDORS: Show details about a recipient of a given user, and their associated remittance IDs
PUT /api/v1/vendors/:vendor_api_token/users/:user_id/recipients/:id VENDORS: Update the attributes of a recipient of a user belonging to a VENDOR partner.
DELETE /api/v1/vendors/:vendor_api_token/users/:user_id/recipients/:id VENDORS: Delete recipient record of a user belonging to a VENDOR partner safely

Vendor remittances

Resource Description
GET /api/v1/vendors/:vendor_api_token/users/:user_id/remittances VENDORS: Show all remittances belonging to the given user
POST /api/v1/vendors/:vendor_api_token/users/:user_id/remittances VENDORS: Initiate a new money transfer by providing a recipient_id and a remittance hash. (VENDOR partner version)
GET /api/v1/vendors/:vendor_api_token/users/:user_id/remittances/:id VENDORS: Show information about a given recipient along with their associated remittance. (VENDOR partner version)
DELETE /api/v1/vendors/:vendor_api_token/users/:user_id/remittances/:id VENDORS: Cancel a remittance. Note that this only changes the status of the remittance but does not delete it from the database. (VENDOR partner version)
POST /api/v1/vendors/:vendor_api_token/users/:user_id/remittances/calculate VENDORS: Returns the processing fee and service fee for a given remittance amount, strategy, and province, scoped by user and vendor.

Vendor user uploads

Resource Description
POST /api/v1/vendors/:vendor_api_token/users/:user_id/uploads/add_photo_id VENDORS: Upload user photo ID, for KYC purposes
POST /api/v1/vendors/:vendor_api_token/users/:user_id/uploads/add_proof_of_residence VENDORS: Upload user photo ID, for KYC purposes

Vendor users

Resource Description
GET /api/v1/vendors/:vendor_api_token/users VENDORS: Show a list of users belonging to this Vendor account
GET /api/v1/vendors/:vendor_api_token/users/:id VENDORS: Show a user belonging to this Vendor account
GET /api/v1/vendors/:vendor_api_token/users/find_by_email VENDORS: Show a user belonging to this Vendor account by supplying their email address
POST /api/v1/vendors/:vendor_api_token/users VENDORS: Create a new user under your Vendor account
POST /api/v1/vendors/:vendor_api_token/users/instant_remit VENDORS: Quick rebittance from an existing user
PUT /api/v1/vendors/:vendor_api_token/users/:id VENDORS: Update the attributes of a user belonging to your Vendor account
PUT /api/v1/vendors/:vendor_api_token/users/:id/update_password VENDORS: Change the password of a user belonging to your Vendor account
DELETE /api/v1/vendors/:vendor_api_token/users/:id VENDORS: Delete a user belonging to this VENDOR partner

Vendors

Resource Description
GET /api/v1/vendors/:vendor_api_token VENDORS: Show information about the current vendor. To receive your VENDOR API Token, please email admin@rebit.ph.
PUT /api/v1/vendors/:vendor_api_token VENDORS: Update some of the attributes of the current Vendor, including Blockchain Wallet GUID and/or password