Simulates the sending of an SMS message to the payment integrator. The association Payment Integrator Account ID (PIAID) will be used for this method call.
The combination of requestId
within the header and paymentIntegratorAccountId
is the idempotency key and uniquely identifies this SMS Diagnostic attempt.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"issuerId": {
"value": "InvisiCashUSA"
},
"senderPhoneNumber": {
"value": "+15555555555"
},
"smsBody": "DCB:bnAxdWTydDX=="
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481900013178"
}
},
"result": {
"acknowledged": {}
}
}
HTTP request
POST https://payment-integrator-carriers-api.google.com/integrator-base-path/carrier-wallets-v1/simulateSms
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
issuer |
REQUIRED: The identifier of the issuer who is the receiver of this simulated SMS message. |
sms |
REQUIRED: The body of this simulated SMS message. This will contain the SMS body prefix as defined by the issuer and the identifier of this authentication session, separated by a colon. |
Union field subscriber_identifier . One subscriber identifier field will be set. This will match the subscriber identifier that is set on the input to the SMS-MO diagnostic test. subscriber_identifier can be only one of the following: |
|
sender |
The subscriber phone number of the sender of this simulated SMS message. |
Response body
This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse
, consult the ErrorResponse
object and HTTP status codes documentation.
Possible response messages | |
---|---|
HTTP 200 Status |
|
HTTP 4XX / 5XX Status |
|
SimulateSmsResponse
Response object for the simulate SMS method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: The result of the SMS diagnostic call. |
SimulateSmsResult
Result codes for smsDiagnostic
.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
acknowledged |
The simulated SMS message has been received. The integrator will do additional steps to parse the authentication token out of the SMS payload, determine if the authentication attempt is successful or declined, and call the |