With Business Bulk Payment Initiation, you can you can send in PAIN001 files with batches on behalf of your users with a Rabobank business payment account and retrieve the status of an initiated transaction or file.

Prerequisites

🚧
There are 2 variations of this API with different prerequisites

Business Bulk Payment Initiation

Signed contract for Rabo Banking Link - Business Payment Initiation
Subscribe your application to Business Payment Initiation
Use OAuth scope: bbpi.bulk.read-write in the consent flow

Business Bulk Payment Initiation - STP

This option is only available if you execute payouts from your own account (Direct Connector)
Signed contract for Rabo Banking Link for Direct Connectors - Business Bulk Payment Initiation STP
Subscribe your application to Business Bulk Payment Initiation STP
Use OAuth scope: bbpi.stp-credittransfer.read-write in the consent flow

Bulk Payments step-by-step

The API user sends the payment order file(s) containing batches with payment orders using the Bulk Payment Initiation.

🚧
For some countries, special rules apply for World Payments. Read more information about countries here: Betalingsinformatie per land
Rabobank provides the third party with the status on the submitted bulk upload.
Flow in case of signing in RBB:
1. The customer authorizes the payment batches in Rabo Business Banking or Rabo Business Banking Pro using Sign/Sign Orders from the menu.
2. After successful authorization, Rabobank processes the payment batches following their payment process, same as if the payment is submitted using a Rabobank channel.
Flow in case of STP:
1. Rabobank processes the payment batches following their payment process, same as if the payment is submitted using a Rabobank channel.
The API user can retrieve the status of the individual payments in the batches through PAIN-002.

Requests

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

The POST call requires a PAIN001 file, read more about it here.

You can initiate a bulk payment with Creation of a bulk payment order of type Sepa Credit Transfer

Endpoints:
Creation of a bulk payment order of type Sepa Credit Transfer
POST /payments/bulk-stp/credit-transfers

Creation of a STP bulk payment order (link to be added)
POST /payments/bulk/credit-transfers

You can retrieve the status of a bulk payment order with Status of a bulk sepa payment

Endpoints:
Status of a bulk sepa payment
GET /payments/bulk/credit-transfers/{paymentId}/status

Status of STP bulk payment (link to be added)
GET /payments/bulk-stp/credit-transfers/{paymentId}/status

📘
You can only use business current accounts as Ordering account/Debtor Account.

Response

POST Payment initiation for Business Bulk Payment Initiation.

You can initiate a bulk credit transfer payment 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.

  `    {
      <?xml version="1.0" encoding="UTF-8"?>
      <InitiatedTransactionResponse>
          <_links>
             <status>
                 <href>/payments/bulk/credit-transfers/123e4567-e89b-42d3-a456-556642440001/status</href>
             </status>
          </_links>
          <paymentId>123e4567-e89b-42d3-a456-556642440001</paymentId>
          <transactionStatus>RCVD</transactionStatus>
      </InitiatedTransactionResponse>
    }
   `

If a required header is not provided or blank, then the status of the response is 400 BAD REQUEST and the response contains the missing header name. For example if the header Signature is missing, then the response is:

`       <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
       <ErrorResponse>
         <errorMessages>
           <category>WARNING</category>
           <code>FORMAT_ERROR</code>
           <text>Required header 'signature' is not present</text>
         </errorMessages>
       </ErrorResponse>
      `

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/credit-transfers.

Request Scenario	Response	Remark
Valid Request with valid PAIN001 xml file	201 CREATED	multipart/form-data with payload variable name as xml_sct
Send Request with required header missing	400 BAD REQUEST	Make a request without a header such as PSU-IP-Address
Large PAIN001 xml file	400 BAD REQUEST	Make a request with PAIN001 xml file larger than 64MB and valid digest
PAIN001 xml file is missing *	400 BAD REQUEST	Make a request without the PAIN001 xml file
PAIN001 xml file is empty *	400 BAD REQUEST	Make a request with and empty PAIN001 xml file
Send Request with invalid signature	401 Unauthorised - Invalid Signature	Make a request with an invalid signature
Send Request with invalid certificate	401 Unauthorised - Invalid Certificate	Make a request with an invalid certificate
Send Request with invalid digest	401 Unauthorised - Invalid digest	Make a request with an invalid digest
If there is no consent for the used accounts	401 Unauthorised - No permissions found	Make a request with an account that has no permissions for this product type
Server issue with the account consent	500 Internal server error	Internal Server Error, Permissions for this product type cannot be accessed
Use PUT instead of POST method	405 Method Not Allowed	Use an incorrect HTTP method when making the request

Note: These codes are for Sandbox only.

*) For these test scenario's use the following values for the Digest and Signature header:

	Scenario	Digest + Signature
	400 Bad Request, PAIN001 missing	digest: sha-512=5M97vlronVu+1jz6CIVqWr1ESjsnqffi94KAIv+gMj/ORJezFZAhU8T3wNhB5iP58TFttF/JD3x0sra/bEw09w== signature: keyId="1523433508",algorithm="rsa-sha512",headers="date digest x-request-id",signature="yelP/MaWk5hrOPc6rB91XQ1E4Kt/IdYFyqF++66sxsUtaRynnD6fi7XCoXWOYj9GyxQGIBpsCKbEq5hw6YHz0XJq0pcm9XppnaqnAoHHdyfLIR0Y4QhkxRK7wnfMb5nd2g7UwuIel6G3AfSnZZsZ6MyRoTl7LHVew3sOp/9GmwFpRjG73e+Yd+8U0xlpYFft8h5fF82/jcNrzk6Qy+tqiZq6l7ETm8Ci6clXP9vUDurzl0X9QlUioAHEaU5L2L4Pa2tY7XfX9VgWL2aRFr2Yt9tG9DM6PDz7D88IpDW6IFxQOLlxyDULnYdLv0XDi7fiIrLXpwMsbyuBCjV9K/oCLA=="
	400 Bad Request, PAIN001 empty	digest: sha-512=5lKRU9FPGFN0tUYBL2YekGApQEwIbaLVesrtP8vm5MapnraP/NWv9LxjyLJpFb2LzqrCimDnmX58Y8//QjLI0Q== signature: keyId="1523433508",algorithm="rsa-sha512",headers="date digest x-request-id",signature="2GBXnuPe6P2vrAr1i0UQk1vUITBPiM9iyItQpsjTVnrcQKTxCeT3GSJRYHAd7OZ+6rKAdiIjLrQz587Pg8rG7rSVR2YMMedEMHYZOtmGO/DZ4tcBW90BMjDNXOu0/r8duxRsxUhPkrM7ae7yTKAORuv7xhFK58dC7J5l+1EqHJBJqOu8A1Ofv1Ho4FFZpnWMeKsArIRjPV4JcXNa4VxBxLcWKYi595N2uLwQQoCl4SWpC36vP5jjOIox+0u8CvMQDl3f6laHlxJIP/c92cEI8zbnZLG4dCzlXxycCevtLqxiUM6L6FwhDO0LGPQ57DS94zwNMgyncsSY6MUGAvRQaw=="

GET Payment Status for Business Bulk Payment Initiation.

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

`    {
      <?xml version="1.0" encoding="UTF-8"?>
      <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.002.001.03">
         <CstmrPmtStsRpt>
              <GrpHdr>
                  <MsgId>RABO-PAIN002-PO-0000000001865281814</MsgId>
                  <CreDtTm>2021-08-09T15:39:03.808</CreDtTm>
                  <InitgPty>
                      <Id>
                          <OrgId>
                              <BICOrBEI>RABONL2U</BICOrBEI>
                          </OrgId>
                      </Id>
                  </InitgPty>
              </GrpHdr>
              <OrgnlGrpInfAndSts>
                  <OrgnlMsgId>MMMM20211231v1</OrgnlMsgId>
                  <OrgnlMsgNmId>PAIN.001.001.03</OrgnlMsgNmId>
                  <OrgnlCreDtTm>2013-07-18T10:00:00.000</OrgnlCreDtTm>
                  <OrgnlNbOfTxs>2</OrgnlNbOfTxs>
                  <OrgnlCtrlSum>0.03</OrgnlCtrlSum>
                  <GrpSts>ACTC</GrpSts>
              </OrgnlGrpInfAndSts>
              <OrgnlPmtInfAndSts>
                  <OrgnlPmtInfId>PmtInfId-MM20211231-1</OrgnlPmtInfId>
                  <OrgnlNbOfTxs>1</OrgnlNbOfTxs>
                  <PmtInfSts>ACSC</PmtInfSts>
              </OrgnlPmtInfAndSts>
              <OrgnlPmtInfAndSts>
                  <OrgnlPmtInfId>PmtInfId-MM20211231-2</OrgnlPmtInfId>
                  <OrgnlNbOfTxs>1</OrgnlNbOfTxs>
                  <PmtInfSts>ACSC</PmtInfSts>
              </OrgnlPmtInfAndSts>
         </CstmrPmtStsRpt>
      </Document>
    }
   `

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

Response	Scenario	Payment-id	Remark
PAIN002 file	200 OK	123e4567-e89b-42d3-a456-556642440001	All statuses are returned as a part of a PAIN002 file after the payment is processed.
RCVD	200 OK	123e4567-e89b-42d3-a456-556642440007	This is an initial status indicating that a payment initiation is received but not yet processed by Rabobank's order manager.
RJCT	200 OK	123e4567-e89b-42d3-a456-556642440008	The payment initiation is rejected
	503 Service Unavailable	123e4567-e89b-42d3-a456-556642444324	Resource Unknown. Internal Server Error. An error occurred during the processing of the request.
	404 NOT_FOUND	123e4567-e89b-42d3-a456-556642440005	Payment Id not found
	400 BAD REQUEST*	<any paymentId>	The request contains invalid or missing data. For example the X-RequestId is missing in the header.
	401 Unauthorised	<any paymentId>	Make a request with an invalid digest or signature or certificate

Note: These codes are for Sandbox only.

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

Scenario

Digest + Signature

400 Bad Request, X-Request-ID

digest: sha-512=z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==
signature: keyId="1523433508",algorithm="rsa-sha512",headers="date digest x-request-id",signature="WhLYvqF/jBvSogfIfhxbmQipzpHrrkhL653VQhCva+UtUsaybjE+jt469iOMu+K2KaQuo0OjxCM4alzLT1fiBGBO1ObhG7RPfa9yepUgeVgLo/Acx2igT/V8RmsU9qwBxQ3aZNWg5gPOHXWA+m34td48kYxkC1a6Z972hcAJnaKPHzGxKgG1cEqbT9HBr1A4CT66nD+ZdvyDezIl9WgswnxjOG6GZqLNZCGAp0ERY4zlwB3cDAEzudZTnwjB9Tw7j9eSDfq1LpgsOlyeKE4ey70xy1cCz+ZldDeWKnRSZtMU7TxcqaQJHyDPvS08XLWX5q1bhDLZjhaEg97OY5uGKQ=="

Response Status

Here is a description of the expected response statuses:

Statuses present in the POST response

RCVD: Payment file received
RJCT: Payment file rejected

Statuses present in the GET response

Interchange status/group status:

ACTC: Payment succesfully created
RJCT: Payment rejected.

Batch status:

RCVD: Payment batch received.
ACTC: Awaiting authorization.
ACCP: Payment authorized.
ACSC: Payment processed.
RJCT: Payment rejected, expired, or cancelled.
PDNG: Payment pending.

Transaction status on individual payment in the batch:

RJCT: Payment rejected.
ACCP: Payment authorized.
CANC: Payment withdrawn.
PDNG: Payment pending.
ACSC: Payment processed.