PaymentAttachments: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (typo) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 12: | Line 12: | ||
This API allows merchants to attach images and files to an already completed payment. The Payment identifier of a completed and successful payment is needed. The attachments will be available for display or download in the Barion web and mobile app. | This API allows merchants to attach images and files to an already completed payment. The Payment identifier of a completed and successful payment is needed. The attachments will be available for display or download in the Barion web and mobile app. | ||
==API Input JSON== | |||
<source lang="javascript"> | <source lang="javascript"> | ||
{ | { | ||
| Line 24: | Line 24: | ||
Type: "Ticket", | Type: "Ticket", | ||
URL: "https://tickets.a38.hu/4565FF-35643F-646C-3475758AB3C", | URL: "https://tickets.a38.hu/4565FF-35643F-646C-3475758AB3C", | ||
FileType: "image/png" //Is this needed? Or can be obtained from URL? | |||
Behavior: "Display", | Behavior: "Display", | ||
}, | }, | ||
| Line 43: | Line 44: | ||
} | } | ||
</source> | </source> | ||
==Process== | |||
Payments are processed the usual way by calling <span class="api-ver">v2</span> [[Payment-Start-v2|/Payment/Start]], then <span class="api-ver">v4</span> [[Payment-PaymentState-v4|/v4/Payment/<PaymentId>/PaymentState]]. If the payment is successful, this API can be called using the PaymentID of the successful payment. | |||
Latest revision as of 10:12, 25 March 2024
WARNING
This is under construction and it is a FUTURE API being designed!
Barion API: Payment Attachments - planned API
| POST | /v2/Payment/Attachments/Add |
|---|
v2 This API endpoint is available in API v2 only.
This API allows merchants to attach images and files to an already completed payment. The Payment identifier of a completed and successful payment is needed. The attachments will be available for display or download in the Barion web and mobile app.
API Input JSON
{
POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC",
PaymentID: "453AC5345-5A66-564D-D348-78754F3453AD", //will attach the files to this payment, if it was successful
Attachments: [
{
Name: "Sisters of Mercy Ticket",
Description: "Sister of Mercy ticket, A38, 2017.09.20 21:30",
Type: "Ticket",
URL: "https://tickets.a38.hu/4565FF-35643F-646C-3475758AB3C",
FileType: "image/png" //Is this needed? Or can be obtained from URL?
Behavior: "Display",
},
{
Name: "Sisters of Mercy Ticket",
Description: "Sister of Mercy ticket, A38, 2017.09.20 21:30",
Type: "Ticket",
URL: "https://tickets.a38.hu/436AFF-38563F-646C-2343579AADD",
Behavior: "Display",
},
{
Name: "Sisters of Mercy Invoice",
Description: "Sister of Mercy Invoice, 12.000,- Ft, 2 pcs",
Type: "Invoice",
URL: "https://tickets.a38.hu/436AFF-38563F-646C-45FFF46898D",
Behavior: "Download",
}
]
}Process
Payments are processed the usual way by calling v2 /Payment/Start, then v4 /v4/Payment/<PaymentId>/PaymentState. If the payment is successful, this API can be called using the PaymentID of the successful payment.