Docs
Standard transaction reference numbers are crucial to ensuring seamless communication between merchants, Riverty, and any platform or PSP partners. The different types of reference numbers and their format are further explain below.
| Description | The order number is a unique reference to a single order. The order number is sent to Riverty's systems in the authorize request. |
|---|---|
| Length | 50 characters (NL and BE: 34 char) |
| Allowed characters | a-zA-Z0-9._- |
| Comment | The order number is sent as a string into authorize and will become part of the path for all following API requests. Also the order number is visible towards the shopper. Try to use as short order numbers as possible |
| Description | The capture number is a unique reference to a capture / an invoice. The capture number is sent to Riverty's systems in the capture request. |
|---|---|
| Length | 19 |
| Allowed characters | a-zA-Z0-9._-/# |
| Comment | If the invoice number is not part of the capture request, a capture number is generated by Riverty. If an invoice number is part of the capture request it will become the capture number. In both situations the capture number is part of the capture response. The capture always relates to a specific order. There cannot be a capture without an order. |
| Description | The creditNote number is a unique reference to a capture / an invoice. The creditNote number is sent to Riverty's systems in the refund request. |
|---|---|
| Length | 19 |
| Allowed characters | a-zA-Z0-9._-/# |
| Comment | If the creditNote number is not part of the capture request, a capture number is generated by Riverty. The creditNote number is part of the refund response. The refund relates always to a specific capture. There can not be a refund without a capture. |
| Description | The parentTransactionReference is a unique reference to an order. The parentTransactionReference is sent to Riverty's systems in all requests. |
|---|---|
| Length | 128 |
| Allowed characters | a-zA-Z0-9._-/# |
| Comment | The parentTransactionReference is an additional reference for the order. It is normally sent in PSP setups in which both the merchant and also the PSP create their own unique references for the specific order. In those setups the merchant creates the order number and the PSP the parentTransactionReference. It is also used in set-ups in which there is a long (internal) order number and a shorter (customer facing) order numner. It is also part of the settlement file. |
| Description | The transactionReference is the unique reference to a specific transaction. The transactionReference is sent to Riverty's systems in all ordermanagement requests (capture / refund / void). |
|---|---|
| Length | 100 |
| Allowed characters | a-zA-Z0-9._-/# |
| Comment | The transactionReference is an additional reference for a specific transaction. It is normally sent in PSP setups in which both the merchant and also the PSP create their own unique references. In those setups the merchant creates the invoice / creditNote number and the PSP the transactionReference. It is also part of the settlement file. |