Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
developer:api_specification:xml_payment_features [2019/12/16 15:46] robinc [Examples for a Request] Added ND008 example |
developer:api_specification:xml_payment_features [2020/04/06 13:31] robinc [Request Body Fields] added decline refund fields |
||
|---|---|---|---|
| Line 313: | Line 313: | ||
| **ND008 - Credential on File** | **ND008 - Credential on File** | ||
| - | This feature is currently available to TSYS Saratoga terminals. | + | This feature is currently available to TSYS Saratoga terminals. The COF tags are required for the following usage: |
| - | + | ||
| - | Two usages: | + | |
| - | * * Processing transaction with Secure Card (stored in Nuvei Gateway) but using the same Secure Card for different usage. | + | |
| * * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway). | * * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway). | ||
| - | These fields will only be used on a payment if you have secure card storage enabled. The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and add them to the transaction, but does not show it to the customer. | + | The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and add them to the transaction, but does not show it to the customer. |
| To provide a transaction with COF, your request needs to add the Credential on File component and its fields, as described below. | To provide a transaction with COF, your request needs to add the Credential on File component and its fields, as described below. | ||
| Line 679: | Line 676: | ||
| \\ | \\ | ||
| - | **ND006 - Credential on File** | + | **ND008 - Credential on File** |
| - | This feature is currently available to TSYS Saratoga terminals. | + | This feature is currently available to TSYS Saratoga terminals. The COF tags are required for the following usage: |
| - | + | ||
| - | Two usages: | + | |
| - | * * Processing transaction with Secure Card (stored in Nuvei Gateway) but using the same Secure Card for different usage. | + | |
| * * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway). | * * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway). | ||
| - | These fields will only be used on a payment if you have secure card storage enabled. The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and adds them to the transaction, but does not show it for the customer. | + | The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and adds them to the transaction, but does not show it for the customer. |
| - | (new table below note ND006) | + | (new table below note ND008) |
| ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ | ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ | ||
| Line 1073: | Line 1067: | ||
| **ND008 - Credential on File** | **ND008 - Credential on File** | ||
| - | This feature is current available to TSYS Saratoga terminals. | + | This feature is current available to TSYS Saratoga terminals. The COF tags are required for the following usage: |
| - | + | ||
| - | Two usages: | + | |
| - | * * Processing transaction with Secure Card (stored in Nuvei Gateway) but using the same Secure Card for different usage. | + | |
| * * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway) | * * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway) | ||
| - | These fields will only be used on a payment if you have secure card storage enabled. The fields will have the following behavior: Hidden - the gateway accepts, if sent, and adds them to the transaction, but does not show it for the customer. | + | The fields will have the following behavior: Hidden - the gateway accepts, if sent, and adds them to the transaction, but does not show it for the customer. |
| To provide a transaction with COF, your request needs to add the Credentials on File component and its fields, as described below. | To provide a transaction with COF, your request needs to add the Credentials on File component and its fields, as described below. | ||
| Line 1145: | Line 1136: | ||
| | DATETIME | Response date and time for the transaction, created by the bank. Format: YYYY-MM-DDTHH:MM:SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.| | | DATETIME | Response date and time for the transaction, created by the bank. Format: YYYY-MM-DDTHH:MM:SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.| | ||
| | HASH | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**, in the next section. | | | HASH | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**, in the next section. | | ||
| + | | BRANDTXIDENTIFIER | The gateway returns the transaction identifier received from Acquirer to the merchant in the response if Credential on File is used. | | ||
| </searchtable> | </searchtable> | ||
| \\ | \\ | ||
| Line 1832: | Line 1824: | ||
| | CARDREFERENCE | N | Secure Card reference generated and returned by the Payment Gateway when created. Either CARDREFERENCE or CARDETAILS should be used on request, never both. | | | CARDREFERENCE | N | Secure Card reference generated and returned by the Payment Gateway when created. Either CARDREFERENCE or CARDETAILS should be used on request, never both. | | ||
| | CARDDETAILS | N | Details of the card to which the refund is going to be done to. Take a look at **ND003 - Card Details** to see this tag's subelements. Either CARDREFERENCE or CARDETAILS should be used on request, never both. | | | CARDDETAILS | N | Details of the card to which the refund is going to be done to. Take a look at **ND003 - Card Details** to see this tag's subelements. Either CARDREFERENCE or CARDETAILS should be used on request, never both. | | ||
| + | | DECLINEDREFUNDUNIQUEREF | N | In the case where the merchant is performing an Unreferenced Refund and linking it to a Declined Online Refund.This tag must be included when the terminal uses UNIQUEREF. The card specified for this Unreferenced Refund must be different than that of the original Declined Refund. | | ||
| + | | DECLINEDREFUNDORDERID | N | In the case where the merchant is performing an Unreferenced Refund and linking it to a Declined Online Refund. - This tag must be included when the terminal does NOT use UNIQUEREF. - If this tag is provided when a terminal specifically uses UNIQUEREF, an error will be returned. - The card specified for this Unreferenced Refund must be different than that of the original Declined Refund. | | ||
| | AMOUNT | Y | The amount of the transaction. A 2 digit decimal or an Integer value for JPY amounts. | | | AMOUNT | Y | The amount of the transaction. A 2 digit decimal or an Integer value for JPY amounts. | | ||
| | AUTOREADY | N | Y or N. If this is set to Y, Nuvei will automatically set the transaction to READY in the batch. If set to N then the transaction will go to a PENDING status. If not present, the terminal default will be used. | | | AUTOREADY | N | Y or N. If this is set to Y, Nuvei will automatically set the transaction to READY in the batch. If set to N then the transaction will go to a PENDING status. If not present, the terminal default will be used. | | ||