Business Instant Payout - Third Party [early access]

The Business Instant Payout for Third Parties API (BIP-TP API) is a fully automated payment solution designed for businesses that handle high transaction volumes.

As a third-party software provider, you can seamlessly integrate instant payouts for partners, users, and employees by having your users pre authorising the payments. While standard payment orders require authorization within the Rabo Business Banking, a BIP transaction is processed using certificates, eliminating this need.

BIP allows you to fully automate payment initiation from your application, enabling instant processing of payment orders.

To know more, read Rabo Banking Link for third parties

📘

The account holder should set up a dedicated current account for use with this integration only, read more about it here.

Relevant scope for oauth2 access code flow

📘

Make sure that you use the Authorization and Token URL as provided by the Authorization Services.

Rate Limiting

A default rate limit plan is set for all APIs. The rate limit can be shared or individual (defined per operation). The table below describes the rate limiting for this product.

Requests

The POST Payment and GET Status requests must contain a digital signature. You can generate a digital signature using the private key of your certificate. For the Sandbox environment, you can use an example certificate available in the Signing documentation.

For detecting a duplicate payment you can use the uniqueRequestorReference field in the body of the request. In case a payment with the exact same uniqueRequestorReference is already present in our order system, the payment just initiated is rejected as duplicate payment.

You can initiate a payment for Business Instant Payout - TP with POST /single-credit-transfers.

POST https://api-sandbox.rabobank.nl/openapi/sandbox/bip/v3/payments/single-credit-transfers

You can retrieve the status of an initiated payment with GET /status.

GET https://api-sandbox.rabobank.nl/openapi/sandbox/bip/v3/payments/single-credit-transfers/123e4567-e89b-42d3-a456-556642440000/status

🚧

• Supported characters allowed range from A-Z, a-z, 0-9
• Special characters include ; . / \ +? ( ) , +E(at) - colon
• No Diacritics letters or characters are allowed

Response

POST Payment initiation for Business Instant Payout - TP

You can initiate an Instant Payment credit transfer using a POST payment request.

After receiving the payment, a response of RCVD or RJCT is returned. You can use the status endpoint to get the latest status of the payment.

To view the POST parameters, read the endpoint description for:

• POST/v3/payments/single-credit-transfers
• POST/v3/payments/cross-border-credit-transfers

{
    "paymentId": "123e4567-e89b-42d3-a456-084452918502",
    "psuMessage": "Payment successfully created.",
    "transactionStatus": "RCVD"
}

Below you can find all supported test scenarios. In order to test these scenarios, call the API by using the examples for the fields provided in the endpoint description for POST/v3/payments/single-credit-transfers.

Note: These codes are for Sandbox only.

*) For these test scenarios use the following values for the Digest and Signature header:

GET Payment Status for Business Instant Payout - TP

You can retrieve the status information for a payment initiation using a GET status request.

To view the GET parameters, read the endpoint description for:

• GET/v3/payments/single-credit-transfers/{paymentId}/status
• GET/v3/payments/cross-border-transfer/{paymentId}/status

{
    "transactionStatus": "RCVD"
}

Some scenarios, as mentioned below, require specific paymentId(s) in the URL, example: (GET /v3/payments/single-credit-transfers/{paymentId}/status) to get the mentioned responses.

Note: These codes are for Sandbox only.

*) For this test scenario use the following values for the Digest and Signature header:

Response statuses

Here is a description of the expected response statuses:

• RCVD: Payment initiation has been received by the receiving agent. Technical validation has started.
• ACSP: All preceding checks were successful. The payment initiation has been accepted for execution but is not yet completed. The payment execution is still in progress.
• ACSC: Settlement on the debtor’s account has been completed.
• ACCC: Settlement on the creditor's account has been completed.
• RJCT: Payment initiation has been rejected.