Notification

Notification API Method

Currently this method is only called after the retailer side submits a commit request to confirm the 1-phase success authcommit. Partner can optionally select to implement this method.

URI: /programs/PROGRAMCODE/cashout/notification

HTTP Method: POST

Request

FieldTypeFormatRequiredDescription
eventIdStringUUIDYesUnique Id of the event
eventTypeStringMax 10 CharsYesType of the event
eventNameStringMax 50 CharsYesName of the event
eventDateTimeStringUTCYesUTC timestamp of event notifying
payloadObjectN/AN/AComplex object

Sample Request

POST https\://<<partnerUrl>>/programs/<<programCode>>/cashout/notification
Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjEiLCJwaS5hdG0iOiJnbXNoIn0.eyJzY29wZSI6IiIsImF1dGhvcml6YXRpb25fZGV0YWlscyI6W10sImNsaWVudF9pZCI6IlVBSUQxMDYzN01OTWljcm9TZXJ2aWNlcyIsImV4cCI6MTcwNzQ3MjcwNX0.d0ohO825c2GaXlBsK_eFx8cyntDzL6f5n-xBfICzGlWpgs1Sop93e36PAiQEse2uScC9QjZoxmg9X312FbJMfipMqbhE5NTZWnL_ofme9gMXDP4OBUwCWnLIgxn5xQS_6JV7z21CEfTtOFi4IHGyaQltxNIE55w-IfQ5npe0S433Np7PC-PGr-7gbB0ouaI-mtti2wGmUXNjb5RqJfpYZXM4nLWhf_O3nIQUSkClIYjjdVSr7bQP2m96OQ8J88-tRdnKy5894UjNYI3yrC6L8r_IfsqhzKjqeAbvongaQiqsNPwEHIHFcU_1FWG70xJYTntIu6HPqGB4CQvjWxHz0VMLku0ygwIH4lG62AEZNHFmSFiUxVNOLAfX-JEIdONbP537MJ5jkx4LuSss6gARbJmdNmO64hK3BgiwKzaatva0FNxzQ4F5J13GHTmMOZcWbEw44ANUPymVtC77mfQmC_LoaboMLei-9Ta1FRSijSoNM0p1m4c8RXina0ptRfz56jpeQ7okaba_dGPvQ0SSbxbiN503P0CJ7TD3UR2DgQdHECb3DRzK-Cbo-k9UNCITbbko3kYKOb9VuXo3JhBs7d6Tf3Cp4ds_9pPyrfIDqGR-ECY4ubcilMtQRblQRMI3qg7zvnjdWjPSK3hSpKunJ7nWCiIQ9lePgo5VLcH2_Lw
X-GD-AuthenticationType: OAuth
X-GD-RequestId: b7b22dc0-6640-11eb-ae93-0242ac130002
Content-Type: application/json
Host: localhost:44362
Content-Length: 343

{
    "eventId": "23d0bba1-bda9-4f77-958a-119a56da8e43",
    "eventType": "CashOut",
    "eventName": "AuthCommit.Committed",
    "eventDateTime": "2024-02-09T03:18:19.6004686Z",
    "payload": {
        "claimCode": "SPA79944835",
        "originalAuthorizationId": "5729af7a-45ad-4caa-89e4-e87cd13f3c2f",
        "transactionReference": "7a91405f06b245f686b3e1877bf83361"
    }
}

Response

No content with http status code 200 or 204 for successful transaction. Please refer to below http status code table for all scenarios.

Http Status CodeDescription
200Success
204Success
400Rejected
500System Error

Sample Response

Return of an HTTP status code 200 or 204 without content.