diff --git a/paysafeapicardpaymentsv1-apiary.apib b/paysafeapicardpaymentsv1-apiary.apib index 2951cda..56cfc37 100644 --- a/paysafeapicardpaymentsv1-apiary.apib +++ b/paysafeapicardpaymentsv1-apiary.apib @@ -1,13 +1,14 @@ FORMAT: 1A HOST: https://api.test.paysafe.com/cardpayments/ -# Paysafe Card Payments API +# Paysafe Card Payments API # Release Notes -| Version | Date | Details | -|--- |--- |--- | -| 1.0 | November 2016 | | +| Version | Date | Details | +|--- |--- |--- | +| 1.0 | November 2016 | Document release| +| 2.0 | September 2017 | Added Turnkey Features | # Overview @@ -62,6 +63,18 @@ For example: `https://api.paysafe.com/cardpayments/v1/accounts/{ACCOUNT_ID}` +# Pagination + + +In the case where an API GET request returns multiple results, Paysafe returns the first 10 records by default and uses HATEOAS links to provide page navigation. In addition to the default behavior, it is also possible to control the number of results and starting point by passing in query parameters as follows: + +| Name | Description | +|--- |--- | +| limit | This is the total number of records to return. Max = 50. Default = 10. | +| offset | This is the starting position, where 0 is the first record. Default = 0. | +| startDate | This is the start date in UTC. Default = 30 days before the *endDate*.| +| endDate | This is the end date in UTC. Default = current date and time. | + # Global Invalid Characters You must not include any of the characters in the following table as values in any of your request parameters. If you do, your request will result in an error. @@ -595,7 +608,7 @@ This is additional information about the card acquirer required when you are per |Element |Type |Required |Description | |--- |--- |--- |--- | |authId |string
`length<=36` |Yes |This is the ID returned in the response to a previous successful Authorization or Settlement request.| -|code |enum |Yes |This is the code for your card acquirer. | +|code |string
`length<=10` |Yes |This is the code for your card acquirer.| ```apib { @@ -730,6 +743,7 @@ These are raw results returned by the acquirer. |acquirerResponse |[acquirerResponse](#acquirerresponseobject) |This is the raw response returned by an acquirer. It is returned only if your account is configured accordingly.| |visaAdditionalAuthData |[visaAdditionalAuthData](#visaadditionalauthdataobject) |This allows additional data to be included with a request using Visa as a payment method.| |level2level3 |[level2level3](#level2level3object) |This allows merchants who are enabled to provide additional L2/L3 transaction data.
**Note:** Not all processing gateways support this parameter. Contact your account manager for more information.| +|splitpay |[splitpay](#splitpayobject) |This enables you to use Split Payouts functionality when authorizing with settlement.| ```apib { @@ -1098,6 +1112,8 @@ merchants who provide more detailed information when processing card-not-present |status |enum |This is the status of the transaction request. Possible values are:| |riskReasonCode |array |An array of integers is returned, displaying the detailed Risk reason codes if your transaction was declined. It is returned only if your account is configured accordingly.| |acquirerResponse |[acquirerResponse](#acquirerresponseobject) |This is the raw response returned by an acquirer. It is returned only if your account is configured accordingly.| +|splitpay |[splitpay](#splitpayobject) |This enables you to use Split Payouts functionality when authorizing with settlement.| + ```apib { @@ -1133,6 +1149,29 @@ merchants who provide more detailed information when processing card-not-present } ``` + +## splitpay + +|Element |Type |Required |Description | +|--- |--- |--- |--- | +|linkedaccount |string |Yes |This is the ID of the linked account. +|amount |number | |This is the amount to transfer to the linked account in minor currency units. The total amount to all linked accounts cannot exceed the transaction total. Either this or percent must be specified.| +|percent |number | |This is the percentage of the total transaction amount to transfer to the linked account, to two decimal places. The total percentage to all linked accounts cannot exceed 100%. Either this or amount must be specified.| + +```apib + { + "splitpay": [ + { + "linkedAccount": "123124124", + "percent": 5 + }, + { + "linkedAccount": "767862873", + "amount": 500 + }] + } +``` + ## standalonecredits @@ -1830,7 +1869,10 @@ This is how you submit an Authorization request that includes the Settlement. To - taxRate:5 (number, optional) - This is the tax rate used to calculate the tax amount. - taxAmount:24000 (number, optional) - This is the amount of any value-added taxes that can be associated with the purchased item, in minor units. - totalAmount:504000 (number, optional) - This is the total amount of the line item, typically calculated as price multiplied by quantity, in minor units. - + + splitpay (object, optional) - For Split Payouts transactions only, an array containing the linked accounts and the amount shared with each. + - linkedAccount:123124124 (string, required) - The ID of the linked account. This must have either a percent or amount, but not both. + - percent:5 (number, optional) - The "percent" (if specified) in the request for the linked account, which is the percentage of the total transaction amount to transfer to that account. This is not returned if an "amount" was specified in the request. + - amount:505 (number, optional) - The amount to transfer to the linked account in minor currency units. This is either the "amount" (if specified) in the request or - if "percent" was specified - the result of the percentage calculation. + Headers @@ -1984,7 +2026,11 @@ This is how you submit an Authorization request that includes the Settlement. To - responseCode:556677j88 (string, optional) - This is the raw response returned by the acquirer. - avsCode:M (string, optional) - This is the raw AVS code returned by the acquirer. - balanceResponse:1200 (string, optional) - This is the balance remaining on a gift card, if a gift card was used for the original transaction. - + + splitpay (object, optional) - For Split Payouts transactions only, an array containing the linked accounts and the amount shared with each. + - linkedAccount:123124124 (string, required) - The ID of the linked account. + - percent:5 (number, optional) - The "percent" (if specified) in the request for the linked account, which is the percentage of the total transaction amount to transfer to that account. This is not returned if an "amount" was specified in the request. + - amount:505 (number, optional) - The amount to transfer to the linked account in minor currency units. This is either the "amount" (if specified) in the request or - if "percent" was specified - the result of the percentage calculation. + + Body { @@ -2056,7 +2102,7 @@ This is how you submit an Authorization request using a payment token. If you us You can use either of two payment token types: -**Note**