Postman Collection

Download our Postman Collection so that you can quickly and easily test Banked's APIs. This collection demonstrates the Banked public API. It shows both recurring payments and single payments. Recurring payments is where there are multiple payments for one mandate and single payments is where one payment triggers a mandate and payment of the same amount in one single payment API call. When enabled, it automates Banked's API security features.

Benfits of using this Postman CollectionCopy URL

• Includes working mandate, payment, refund and webhook API examples: Simply follow the steps below to quickly get up and running
• Includes both single payments and recurring payments: Shows example flows for both single payments and also recurring payments.
• Generates OAuth tokens: Generates OAuth tokens which are then used in subsquent API calls.
• Automatically populates Postman variables: Automatically stores Postman mandate IDs, payment IDs and other variables which are used in subsquent API calls in the colletion.
• Automates request signature generation: When enabled, there is a built in script which automatically generates the API request signature
• Automates response message level encryption: When enabled, there is built in script which automatically decrypts the API response messages and displays them on the Postman console.

Quick Start GuideCopy URL

Generic steps required for both recurring and single payments:Copy URL

Enter the following Postman collection values provided to you by Banked:

• oauth_merch_client_id
• oauth_merch_client_secret
• application_id
• bank_account_id

If your API account is set up with request signature verification and/or response message level encryption then enter these RSA PEM private key values in the initial and current Postman collection variable values.

Steps to create recurring payments:Copy URL

1. Create an OAuth token. Please note the tokens only live for 2 hours so you will need to create a new OAuth token every 2 hours.
2. Open the recurring folder in the Postman collection
3. Send a create mandate request
4. Open the mandate url value returned in a browser. This value comes in the API response which will be in the Postman console if the response is encrypted.
5. Follow the prompts to activate the mandate. If using PayTo then use a test BSB of 111-114 and an account of 010111 to simulate an approved PayTo agreement.
6. Send a get mandate to check the mandate is in an active state.
7. Send a create payment request
8. Send a get payment and check if the state is in a "sent" state which means the money has settled.
9. Repeat steps 7 and 8 for subsequent payments.

Steps to create single payments:

1. Create an OAuth token. Please note the tokens only live for 2 hours so you will need to create a new OAuth token every 2 hours.
2. Open the single payments folder in the Postman collection
3. Send a create payment request
4. Open the url value returned in a browser. This value comes in the API response which will be in the Postman console if the response is encrypted.
5. Follow the prompts to approve the payment. If using PayTo then use a test BSB of 111-114 and an account of 010111 to simulate an approved PayTo agreement/payment.
6. Send a get payment and check if the state is in a "sent" state which means the money has settled.