Procesoverzicht
Soorten verzoeken
Bij het lezen van dit document moet u zich bewust zijn van drie verschillende soorten verzoeken die worden verwerkt:
- Ten eerste, een THREEDQUERY verzoek wordt verwerkt, dat wordt gebruikt om 3-D Secure authenticatie uit te voeren.
- Ten tweede, een AUTH verzoek is verwerkt, dat wordt gebruikt om de eerste betaling te verwerken. Deze fungeert als bovengeschikte voor alle volgende geautomatiseerde betalingen in deze reeks.
- Tot slot, een SUBSCRIPTION verzoek wordt verwerkt, dat wordt gebruikt om onze Abonnementsmodule te vertellen wanneer de daaropvolgende automatische betalingen moeten worden verwerkt.
De JWT bijwerken payload
U moet de payload binnen het JWT om de SUBSCRIPTION in te dienen en ook aanvullende velden te bevatten die specifiek zijn voor dit proces.
De transactie
Wanneer de klant op "Pay" op uw afrekenformulier, wordt de klant geverifieerd met 3-D Secure. Hierna wordt een betaling onmiddellijk verwerkt en - na Afwikkeling - toekomstige betalingen worden gepland in onze Abonnementsmodule. Alle volgende betalingen worden automatisch verwerkt door onze Abonnementsmodule. Het aantal te verwerken volgende betalingen wordt gedefinieerd in het JWT.
Optie om de eerste betaling uit te stellen
Als u de eerste betaling wilt uitstellen tot na het eerste interval, klik dan hier voor documentatie over een alternatief proces dat dit ondersteunt.
Configuratie
De JWT bijwerken
U moet de JWT payload om extra velden te bevatten die de informatie geven die nodig is om het abonnement te plannen na de eerste betaling.
Voorbeeld
{
"payload":{
"accounttypedescription":"ECOM",
"baseamount":"1050",
"currencycode":"GBP",
"sitereference":"test_site12345",
"subscriptiontype":"RECURRING",
"subscriptionunit":"MONTH",
"subscriptionfrequency":"1",
"subscriptionnumber":"1",
"subscriptionfinalnumber":"12",
"subscriptionbegindate":"2020-01-01",
"credentialsonfile":"1",
"requesttypedescriptions":["THREEDQUERY","AUTH","SUBSCRIPTION"]
},
"iat":"1567701632",
"iss":"jwt.user"
}
Specificatie veld
Veld | Formaat | Beschrijving | |
baseamount | Numeriek (13) | Het bedrag dat met regelmatige tussenpozen moet worden betaald, in basiseenheden, zonder komma's of decimalen, dus €10 wordt ingediend als 1000. Deze waarde moet groter zijn dan nul. (De maximale lengte kan variëren afhankelijk van uw bank - neem contact op met uw bank voor meer informatie). | |
credentialsonfile | Numeriek (1) |
Dien de waarde "1" in om aan te geven dat de in het oorspronkelijke verzoek verstrekte referenties worden opgeslagen voor volgende abonnementsbetalingen. Opmerking: Visa en Mastercard hebben bepaald dat u toestemming van de kaarthouder moet krijgen voordat u kaartgegevens opslaat voor toekomstig gebruik. Klik hier voor meer informatie. Als uw systeem er niet in slaagt deze waarde in het verzoek in te dienen, zal ons systeem automatisch poging om het verzoek te markeren met de juiste credentialsonfile waarde. Als u een nieuw abonnement verwerkt met eerder opgeslagen referenties, moet u nog steeds het volgende indienen credentialsonfile = 1, om aan te geven dat de referenties opgeslagen blijven voor betalingen in deze specifieke abonnementsreeks. |
|
currencyiso3a | Alpha (3) |
De Munt toegewezen aan elke betaling in de abonnementsreeks. Klik hier voor een volledige lijst van beschikbare munteenheden. |
|
requesttypedescriptions | Lijst | Dit moet worden ingesteld op [“THREEDQUERY”,”AUTH”,”SUBSCRIPTION”]. | |
subscriptionbegindate | Datum JJJJ-MM-DD |
Dit veld verwijst naar wanneer de eerste geautomatiseerd betaling zal worden verwerkt. Vanaf dat moment gebruiken wij de gegevens die in de subscriptionunit en subscriptionfrequency velden om de abonnementsbetalingen op gezette tijden automatisch te verwerken.
bijv. Als een abonnementsaanvraag wordt ingediend op 5 januari 2018 het interval is 1 MONTH (subscriptionfrequency = 1 en subscriptionunit = MONTH) en subscriptionbegindate is 2018-01-08, de eerste automatische betaling wordt verwerkt op 8 januari 2018, en alle volgende betalingen worden verwerkt op de 8e van elke maand. Als u de subscriptionbegindate, zullen we de subscriptionunit en subscriptionfrequency velden hierboven om de eerste automatische betaling automatisch te plannen. Maandabonnementen die aan het einde van de maand worden ingepland, worden op de 28e dag verwerkt. Als de datum van de eerste automatische betaling de 29e, 30e of 31e dag is, worden alle volgende betalingen in de daaropvolgende maanden op de 28e dag verwerkt. Dit is om problemen te voorkomen met abonnementsbetalingen in maanden die minder dagen hebben dan andere. |
|
subscriptionfinalnumber | Numeriek (5) |
Dit wordt gebruikt om het aantal te verwerken betalingen in de loop van het abonnement in te stellen: Bij de verwerking van een gecombineerd AUTH SUBSCRIPTION verzoek: Als subscriptionnumber = 1 Let op: Als de subscriptionfinalnumber waarde "0" is, plant de Abonnementsmodule betalingen voor onbepaalde tijd totdat de gebruiker het abonnement handmatig op Inactief. |
|
subscriptionfrequency | Numeriek (11) |
In combinatie met eenheid bepaalt de frequentie hoe vaak betalingen worden verwerkt. bijvoorbeeld voor een betaling om de 7 dagen: subscriptionfrequency = 7 en subscriptionunit = DAY bijvoorbeeld voor een betaling om de 2 maanden: subscriptionfrequency = 2 en subscriptionunit = MONTH |
|
subscriptionnumber | Numeriek (5) |
|
|
subscriptiontype | Alpha (11) |
Dit veld geeft het type abonnement aan dat moet worden verwerkt. Uw systeem kan deze twee waarden indienen:
*Installaties worden ondersteund voor winkeliers met een Trust Payments acquiring account. Als u een andere acquiring bank gebruikt, moet u contact opnemen met ons Support Team om te controleren of deze functie wordt ondersteund voordat u verder gaat. |
|
subscriptionunit | Alfa (5) |
Dit veld vertegenwoordigt de tijdseenheid tussen elk abonnement. Dit kan ofwel "DAY" of "MONTH" zijn. Opmerking: Dit veld moet absoluut in HOOFDLETTERS ("DAY" of "MONTH") bij de gateway worden ingediend. |
|
transactionactive | Numeriek (1) |
De abonnementsstatus.
"0" - Inactief: Schort toekomstige betalingen op totdat deze handmatig worden opgeheven. (Zie informatie over het bijwerken van abonnementen hieronder) "1" - Actief: Plannen van abonnementsbetalingen onmiddellijk, waarbij fraude en dubbele controles worden omzeild (indien ingeschakeld). "2" - In afwachting (standaard): Plannen van abonnementsbetalingen nadat de AUTH is betaald (settlestatus "100"). |
Het bedrag voor volgende abonnementsbetalingen wijzigen
U kunt een abonnement plannen voor een ander bedrag dan dat van de eerste betaling (bv. de eerste AUTH is voor €5,99 en de SUBSCRIPTION is voor €9,99 per maand).
- Daartoe moet u eerst een gecombineerd AUTH SUBSCRIPTION verzoek indienen zoals hierboven beschreven, inclusief de baseamount voor de eerste betaling.
- Verwerk dan een TRANSACTIONUPDATE verzoek, inclusief de transactionreference van de SUBSCRIPTION, en een nieuwe baseamount die de waarde bevat die de klant tijdens het abonnement gefactureerd moet worden.
Behandeling van het antwoord
Nadat de klant de betaalsessie heeft voltooid, ontvangt u een enkel antwoord JWT dat bestaat uit de antwoorden THREEDQUERY, AUTH en SUBSCRIPTION .
Elke JWT die door de SDK wordt geretourneerd, moet worden geverifieerd voordat u verdergaat. Wij bieden een parsing-hulpprogramma dat het gemakkelijker maakt om de JWT om te zetten in een transactieantwoordobject. Klik hier voor een voorbeeld hoe dit te gebruiken.
-
Bij het controleren van de reacties op THREEDQUERY en AUTH :
- We raden aan de controles op de JSON Web Token pagina om de respons te controleren.
- Onze Abonnementsmodule zal geen betalingen plannen tenzij de eerste betaling (AUTH) met succes is voldaan (settlestatus is "100"). Zolang dit niet is gebeurd, is de transactionactive veld in de SUBSCRIPTION zal de waarde "2" hebben, wat aangeeft dat het abonnement "In afwachting" is.
-
Bij het controleren van het antwoord op SUBSCRIPTION :
- Het is belangrijk dat dit verzoek succesvol is (controleer de errorcode is "0"). Alle andere errorcode waarden geven aan dat het abonnement niet gepland is.
- De abonnementsspecifieke velden (zoals hier beschreven) moeten de waarden weergeven die in het verzoek zijn ingediend. Deze dicteren hoe vaak automatische betalingen door de Abonnementsmodule moeten worden verwerkt, welk bedrag van de klant wordt afgeschreven en wanneer het abonnement wordt voltooid.
Als het antwoord op AUTH aangeeft dat het verzoek succesvol was, zijn de middelen voor de eerste betaling gereserveerd op de rekening van de klant.
Beheer van het abonnement
Begin van de geautomatiseerde betalingen
Denk eraan!
De eerste betaling wordt onmiddellijk na de eerste aanvraag verwerkt. Alle volgende betalingen worden automatisch verwerkt door onze Abonnementsmodule.
De eerste automatische betaling zal als volgt worden verwerkt:
- Als subscriptionbegindate is opgegeven, zal de eerste geautomatiseerde betaling op deze datum worden verwerkt.
- Als subscriptionbegindate heeft niet aangegeven, zal de eerste geautomatiseerde betaling worden verwerkt nadat het in het verzoek aangegeven interval is verstreken (bv. 1 MONTH of 7 DAY).
Uw abonnementen bijhouden
-
U kunt inloggen op MyST en van daaruit uw geplande abonnementen volgen. U kunt reeds verwerkte betalingen bekijken en ook toekomstige geplande betalingen in onze Abonnementsmodule bekijken.
Klik hier voor meer informatie.
-
U kunt ervoor kiezen om e-mailberichten of URL-kennisgevingen te ontvangen wanneer automatische abonnementsbetalingen op uw rekening zijn verwerkt.
Klik hier voor meer informatie.
-
U kunt een TRANSACTIONQUERY verzoek indienen, die door de transactionreference teruggestuurd in het gedeelte SUBSCRIPTION van het initiële antwoord. Het teruggestuurde antwoord TRANSACTIONQUERY bevat velden met informatie over toekomstige geplande betalingen.
Klik hier voor meer informatie.
Het abonnement bijwerken
U kunt updates uitvoeren op actieve abonnementen om de gegevens van de klant te wijzigen, of om de abonnementsbetalingen te annuleren/wijzigen. Er zijn twee manieren om dit te doen:
-
U kunt zich aanmelden bij MyST en van daaruit uw geplande abonnementen beheren.
Klik hier voor meer informatie.
-
U kunt een TRANSACTIONUPDATE verzoek indienen, die door de transactionreference teruggestuurd in het gedeelte SUBSCRIPTION van het initiële antwoord.
Klik hier voor meer informatie.
Het abonnement afronden
Abonnementen kunnen in een van deze twee toestanden terechtkomen:
Aantal betalingen overschreden
Zodra de subscriptionnumber overschrijdt de subscriptionfinalnumber, stopt onze Abonnementsmodule voor onbepaalde tijd met het verwerken van abonnementsbetalingen.
Als u geen verdere betalingen van de klant hoeft te verwerken, hoeft u geen verdere actie te ondernemen.
Als u een abonnement wilt hervatten/verlengen, kunt u de subscriptionfinalnumber naar een grotere waarde. U kunt dit doen via MyST, of door een verzoek in te dienen op TRANSACTIONUPDATE. Wanneer deze update is voltooid, zullen de betalingen weer op hun oorspronkelijke intervallen worden verwerkt. Als betalingen zijn gemist terwijl de abonnementsbetalingen niet werden verwerkt, zal onze Abonnementsmodule gemiste betalingen inhalen binnen 24 uur.
Abonnement loopt onbeperkt door
Indien het oorspronkelijke verzoek werd ingediend met subscriptionfinalnumber ingesteld op "0", blijven wij betalingen voor onbepaalde tijd verwerken totdat u het abonnement handmatig deactiveert.
Als u het abonnement wilt deactiveren, kunt u dit doen door de transactionactive veld op "0" te zetten. U kunt dit doen via MyST, of door een TRANSACTIONUPDATE verzoek in te dienen (u kunt een abonnement eventueel later weer inschakelen).