- HTTP request
- Request body
- Response body
- RecurringPaymentMandate
- InPlaceTokenizedCardPayment
- AddressVerificationData
- AuthenticationDetails
- RecurringPaymentDetails
- Frequency
- InstallmentPayment
- InstallmentPlanType
- CaptureResponse
- CardNetworkResult
- RawResult
- ProcessorDebugInformation
- AddressVerificationResult
- AddressVerificationNotSent
- NotSentAvsSupport
- AddressVerificationSentUnsupported
- AvsNotSupportedReason
- AddressVerificationSentResult
- VerificationResult
- CaptureResultCode
- CardMetadata
- CardType
- RecurringMandateDetails
- MandateStatus
- MandateCreationDetails
Captures funds from a user's card.
This call synchronously attempts to capture funds from a user's card. The response to this message will return the result of that attempt. The combination of requestId
within the header and paymentIntegratorAccountId
is the idempotency key and uniquely identifies this transaction. All mutations on this transaction populate the requestId
value in their captureRequestId
field.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example of a standard payment request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "G112YZH4XPDV88J",
"requestTimestamp": {
"epochMillis": "1481907920000"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
},
"accountDetails": {
"card": {
"accountNumber": "4123456789101112",
"nameOnCard": "Example Customer",
"expiryMonth": "01",
"expiryYear": "20",
"cvn": "123"
}
},
"amount": {
"amountMicros": "728000000",
"currencyCode": "INR"
},
"transactionDescription": "Movie ACB",
"merchantCategoryCode": "5815",
"addressVerificationData": {
"addressLine": ["2 Inner Ring Road"],
"localityName": "Bangalore",
"administrativeAreaName": "Karnataka",
"postalCodeNumber": "560071",
"countryCode": "IN"
},
"authenticationNotAttempted" : {}
}
An example of a standard payment response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": 1481907920760
}
},
"paymentIntegratorCaptureId": "36be1a5d-ff21-455d-8dba-e3c4306e193e",
"cardNetworkResult": {
"rawResult": {
"scope": "VISA",
"rawCode": "00"
},
"authorizationCode": "123456"
},
"addressVerificationResult": {
"result": {
"rawAvsResult": "M",
"addressLine": "MATCH",
"localityName": "MATCH",
"administrativeAreaName": "MATCH",
"postalCodeNumber": "MATCH",
"countryCode": "MATCH",
"nameOnCard": "MATCH"
}
},
"cvnResult": "MATCH",
"result": "SUCCESS",
"cardMetadata": {
"issuerName": "exampleissuer",
"issuingCountryCode": "IN",
"networks": ["VISA"],
"cardType": "CREDIT_CARD"
}
}
An example of a recurring payment with mandate creation looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "G112YZH4XPDV88J",
"requestTimestamp": {
"epochMillis": "1481907920000"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
},
"authenticateRequestId": "G13478DFHKE123HG74",
"amount": {
"amountMicros": "728000000",
"currencyCode": "INR"
},
"transactionDescription": "Movie ACB",
"merchantCategoryCode": "5815",
"addressVerificationData": {
"addressLine": ["2 Inner Ring Road"],
"localityName": "Bangalore",
"administrativeAreaName": "Karnataka",
"postalCodeNumber": "560071",
"countryCode": "IN"
},
"authenticationWasSuccessful" : {
"paymentIntegratorAuthenticationId": "6e77bd35-3fca-4b03-9cbb-6586c31def72",
"recurringPaymentDetails": {
"customerReferenceId": "customer57",
"recurringPaymentReferenceId": "subscription201",
"recurringPaymentDescription": "Google TV",
"startDate": {
"year": 2021,
"month": 1,
"day": 21
},
"endDate": {
"year": 2099,
"month": 12,
"day": 31
},
"frequency": "MONTHLY",
"fixedAmount": {
"amountMicros": "728000000",
"currencyCode": "INR"
}
}
}
}
An example of a recurring payment with mandate creation response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": 1481907920760
}
},
"paymentIntegratorCaptureId": "36be1a5d-ff21-455d-8dba-e3c4306e193e",
"cardNetworkResult": {
"rawResult": {
"scope": "VISA",
"rawCode": "00"
},
"authorizationCode": "123456"
},
"addressVerificationResult": {
"result": {
"rawAvsResult": "M",
"addressLine": "MATCH",
"localityName": "MATCH",
"administrativeAreaName": "MATCH",
"postalCodeNumber": "MATCH",
"countryCode": "MATCH",
"nameOnCard": "MATCH"
}
},
"cvnResult": "MATCH",
"result": "SUCCESS",
"cardMetadata": {
"issuerName": "exampleissuer",
"issuingCountryCode": "IN",
"networks": ["VISA"],
"cardType": "CREDIT_CARD"
},
"recurringMandateDetails": {
"mandateId": "MA061B00045154",
"mandateStatus": "ACTIVE",
"mandateCreationDetails" : {
"integratorPaymentToken" : {}
}
}
}
An example of a recurring payment request using a mandate looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "G112YZH4XPDV88J",
"requestTimestamp": {
"epochMillis": "1481907920000"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
},
"recurringPaymentMandate": {
"mandateId": "MA061B00045154",
"recurringPaymentReferenceId": "subscription201",
"paymentIntegratorNotificationId": "invoiceid1234"
},
"amount": {
"amountMicros": "728000000",
"currencyCode": "INR"
},
"transactionDescription": "N/A",
"merchantCategoryCode": "N/A",
"authenticationNotAttempted" : {}
}
An example of a recurring payment response using a mandate looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": 1481907920760
}
},
"paymentIntegratorCaptureId": "36be1a5d-ff21-455d-8dba-e3c4306e193e",
"cardNetworkResult": {
"rawResult": {
"scope": "VISA",
"rawCode": "00"
},
"authorizationCode": "123456"
},
"addressVerificationResult": {
"notSent": {
"support": "SUPPORTED"
}
},
"cvnResult": "NOT_SENT_SUPPORTED",
"result": "SUCCESS",
"cardMetadata": {
"issuerName": "exampleissuer",
"issuingCountryCode": "IN",
"networks": ["VISA"],
"cardType": "CREDIT_CARD"
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/v1/payment-integrator-authenticated-card-fop-api/capture
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
amount |
REQUIRED: The amount of the purchase, in micros of the currency unit. |
transaction |
REQUIRED: This is the description of the transaction that can be put on the customer's statement. The format can be changed without notice and therefore this value must never be parsed. This field will always be sent, however it is understood that not all issuers or networks support it. In those cases it does not have to be used. This field is classified as SPII because it can contain sensitive information, for example one-time password. |
merchant |
REQUIRED: This is the ISO 18245 merchant category code (MCC) identifying the type of goods/services being purchased by the user. |
address |
OPTIONAL: The user's billing address to be verified by AVS. |
Union field account_details_source . REQUIRED: The source of the details about the card the user is paying with. account_details_source can be only one of the following: |
|
account |
Data about the user's payment card. |
authenticate |
The |
recurring |
The payment is a recurring payment and can be made with an existing mandate. |
in |
A |
Union field authentication_attempted . REQUIRED: This is used to specify whether an attempt was made to authenticate the user with an authenticateRequest . authentication_attempted can be only one of the following: |
|
authentication |
An attempt was not made to authenticate the user. This typically means the request was system initiated. |
authentication |
There was a successful call to |
authentication |
An inconclusive attempt was made to authenticate the user. |
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 |
|
RecurringPaymentMandate
Object to represent info related to a recurring payment mandate that can be used to make a purchase.
JSON representation |
---|
{ "mandateId": string, "recurringPaymentReferenceId": string, "paymentIntegratorNotificationId": string } |
Fields | |
---|---|
mandate |
REQUIRED: The mandate ID associated with this recurring payment. |
recurring |
REQUIRED: The reference ID associated with this recurring payment. |
payment |
REQUIRED: The payment integrator generated ID for the notification that was sent to the user. This is returned from the related |
InPlaceTokenizedCardPayment
This object is used to pass details when india-cards-v1.authenticate
was called with a card
and the card was then tokenized. The new paymentToken
is passed with the requestId
for the AuthenticateRequest
so a capture can be attempted on the paymentToken
.
JSON representation |
---|
{
"paymentToken": {
object ( |
Fields | |
---|---|
payment |
Representation of a card that has been tokenized by the network. |
authenticate |
The |
AddressVerificationData
Contains address fields to be verified by AVS.
JSON representation |
---|
{ "addressLine": [ string ], "localityName": string, "administrativeAreaName": string, "postalCodeNumber": string, "countryCode": string } |
Fields | |
---|---|
address |
OPTIONAL: This holds unstructured Address text. |
locality |
OPTIONAL: This is something of a fuzzy term, but it generally refers to the city/town portion of an address. In regions of the world where localities are not well defined or do not fit into this structure well (for example, Japan and China), leave localityName empty and use addressLine. Examples: US city, IT comune, UK post town. |
administrative |
OPTIONAL: The top-level administrative subdivision of this country for the user's billing address. Examples: US state, IT region, UK constituent nation, JP prefecture When country == US, this is expected to be the 2-character abbreviation for the US State. |
postal |
OPTIONAL: The user's billing postal code. |
country |
OPTIONAL: The country code of the user's billing address in ISO-3166-1 Alpha-2 format. |
AuthenticationDetails
Contains details about the authentication that was performed.
JSON representation |
---|
{ "paymentIntegratorAuthenticationId": string, "recurringPaymentDetails": { object ( |
Fields | |
---|---|
payment |
OPTIONAL: This identifier is specific to the integrator and is generated by the integrator. The integrator identifies this authentication attempt in their system by this identifier. This will be populated when it was included in the |
recurring |
OPTIONAL: If present, a recurring payment is being configured. This contains details about those payments so a mandate can be created. |
installment |
OPTIONAL: If present, an installment payment is being configured. This contains details required to determine the installment charges and duration. |
RecurringPaymentDetails
Object used to pass details needed for the creation of a recurring payment mandate that can be used to make future payments.
JSON representation |
---|
{ "customerReferenceId": string, "recurringPaymentReferenceId": string, "recurringPaymentDescription": string, "startDate": { object ( |
Fields | |
---|---|
customer |
REQUIRED: Google generated ID to reference this customer. |
recurring |
REQUIRED: Google generated ID to reference this recurring payment. |
recurring |
REQUIRED: Description of the recurring payment. |
start |
REQUIRED: Date of when the recurring payment began. |
end |
REQUIRED: Date of when this recurring payment ends. If the subscription does not have an end date, this will be set to a day far in the future, such as 31st Dec, 2099. |
frequency |
REQUIRED: The expected frequency of the recurring payment. |
Union field recurring_payment_amount . REQUIRED: The amount of the recurring payment, in micros of the currency unit. recurring_payment_amount can be only one of the following: |
|
fixed |
The recurring payment is for a fixed amount. |
maximum |
The recurring payment is for a variable amount up to this value. |
Frequency
The expected frequency of the recurring payment.
Enums | |
---|---|
FREQUENCY_UNSPECIFIED |
Do not ever set this default value! |
WEEKLY |
Weekly payments are expected. |
MONTHLY |
Monthly payments are expected. |
BI_MONTHLY |
A payment is expected twice a month. |
QUARTERLY |
Quarterly payments are expected. |
BI_ANNUALLY |
Payments will occur twice a year. |
YEARLY |
Yearly payments are expected. |
ADHOC |
Payments do not have a set frequency. |
InstallmentPayment
Object used to pass details needed for the creation of an installment payment.
JSON representation |
---|
{
"installmentPlanType": enum ( |
Fields | |
---|---|
installment |
REQUIRED: Installment term for the installment plan. |
InstallmentPlanType
The type of the installment plan.
Enums | |
---|---|
INSTALLMENT_PLAN_TYPE_UNSPECIFIED |
Do not ever set this default value. |
INSTALLMENT_PLAN_3_MONTHS |
An installment plan paid in 3 installments. |
INSTALLMENT_PLAN_6_MONTHS |
An installment plan paid in 6 installments. |
INSTALLMENT_PLAN_9_MONTHS |
An installment plan paid in 9 installments. |
INSTALLMENT_PLAN_12_MONTHS |
An installment plan paid in 12 installments. |
INSTALLMENT_PLAN_18_MONTHS |
An installment plan paid in 18 installments. |
INSTALLMENT_PLAN_24_MONTHS |
An installment plan paid in 24 installments. |
CaptureResponse
Response object for the payment integrator hosted india-cards-v1.capture method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
payment |
OPTIONAL: This identifier is specific to the integrator and is generated by the integrator. The integrator identifies this capture in their system by this identifier. For convenience, this identifier is included with in the remittance details |
card |
REQUIRED: The result of issuing the capture on the card network. |
address |
REQUIRED: The result of verifying the address fields sent in the request. |
cvn |
REQUIRED: The result of verifying the CVN sent in the request. If the CVN was not set on the request, this value should be |
result |
REQUIRED: Result of this call. |
card |
REQUIRED: Optional metadata about the card that may be useful for future processing and debugging. |
Union field recurring_mandate_result . OPTIONAL: Details about a recurring mandate, if applicable. recurring_mandate_result can be only one of the following: |
|
recurring |
The creation of a recurring mandate was requested and successful. |
recurring |
The creation of a recurring mandate was requested, but it is not required for this transaction, e.g. because it is an international card that is out of scope. |
recurring |
The creation of a recurring mandate was requested, but it is not currently supported for this transaction, e.g. the issuer does not yet support mandates. This differs from |
recurring |
The creation of a recurring mandate was not requested. |
CardNetworkResult
Contains a network and a raw result code from that network.
JSON representation |
---|
{ "rawResult": { object ( |
Fields | |
---|---|
raw |
REQUIRED: The raw response code from the network to this call. This is informational only. |
authorization |
The Authorization Verification Code returned from the Card Network during the reservation of funds. Any time that this Code is provided by the network, it should be returned to Google. Common names for this field include: Auth code, Verification Code, Authorization Number, Authorization ID, Approval Code |
processor |
OPTIONAL: The additional transactional information which is useful for debugging or troubleshooting purpose only. |
RawResult
Raw result object.
JSON representation |
---|
{ "scope": string, "rawCode": string } |
Fields | |
---|---|
scope |
OPTIONAL: Scope of the rawCode, can be empty. |
raw |
REQUIRED: Raw code from the integrator or subsystems within it. |
ProcessorDebugInformation
This contains the additional information sent by the processor which is useful for debugging or analysis purposes only.
JSON representation |
---|
{ "errorCode": string, "category": string, "details": string } |
Fields | |
---|---|
error |
OPTIONAL: This contains specific identifier or error code from the processor system. |
category |
OPTIONAL: This contains type or category of failure. |
details |
REQUIRED: The detailed information or internal error description which is useful for investigation purposes. |
AddressVerificationResult
The result of verifying the address fields provided in the request.
All fields are required because we want an explicit result for each field rather than relying on the absence of a field as an implied result.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
not |
Google did not send |
sent |
Google sent |
result |
Google sent |
AddressVerificationNotSent
JSON representation |
---|
{
"support": enum ( |
Fields | |
---|---|
support |
REQUIRED: If |
NotSentAvsSupport
Enums | |
---|---|
NOT_SENT_AVS_SUPPORT_UNSPECIFIED |
Do not ever set this default value! |
UNSUPPORTED_BY_INTEGRATOR |
If addressVerificationData had been sent, the integrator would not have been able to support it. |
UNSUPPORTED_BY_NETWORK |
If addressVerificationData had been sent, the network would not have been able to support it. |
UNSUPPORTED_BY_ISSUER |
If addressVerificationData had been sent, the issuer would not have been able to support it. |
SUPPORTED |
If addressVerificationData had been sent, the integrator would have been able to support it. |
AVS_SUPPORT_NOT_KNOWN |
If addressVerificationData had been sent, it is unknown if it would have been supported or not. |
AddressVerificationSentUnsupported
JSON representation |
---|
{
"reason": enum ( |
Fields | |
---|---|
reason |
REQUIRED: The |
AvsNotSupportedReason
Enums | |
---|---|
AVS_NOT_SUPPORTED_REASON_UNSPECIFIED |
Do not ever set this default value! |
UNSUPPORTED_BY_INTEGRATOR |
The integrator could not support Address Verification for this request. |
UNSUPPORTED_BY_NETWORK |
The network could not support Address Verification for this request. |
UNSUPPORTED_BY_ISSUER |
The issuer could not support Address Verification for this request. |
AddressVerificationSentResult
JSON representation |
---|
{ "rawAvsResult": string, "addressLine": enum ( |
Fields | |
---|---|
raw |
REQUIRED: The raw AVS value returned from the card network. If |
address |
REQUIRED: The result of verifying the |
locality |
REQUIRED: The result of verifying the |
administrative |
REQUIRED: The result of verifying the |
postal |
REQUIRED: The result of verifying the |
country |
REQUIRED: The result of verifying the |
name |
REQUIRED: The result of verifying the |
VerificationResult
Enums | |
---|---|
VERIFICATION_RESULT_UNSPECIFIED |
Do not ever set this default value! |
MATCH |
Google sent the field to the integrator and it was checked via AVS and it matched the expected value. |
MISMATCH |
Google sent the field to the integrator and it was checked via AVS but did not match the expected value. |
NOT_SPECIFIED |
Google sent the field to the integrator and the integrator checked the field via AVS, but the AVS result code does not provide enough info for the integrator to know if the field matched the expected the value. |
SKIPPED_BY_NETWORK |
Google sent the field to the integrator but the Network did not return an AVS result (due to timeout etc.). |
SKIPPED_BY_ISSUER |
Google sent the field to the integrator but the issuer did not perform AVS (due to timeout etc.). |
CaptureResultCode
Result codes for the capture
method.
Enums | |
---|---|
CAPTURE_RESULT_CODE_UNSPECIFIED |
Do not ever set this default value! |
SUCCESS |
india-cards-v1.capture notification was successfully processed. |
CARD_ACTIVITY_EXCEEDS_AMOUNT_LIMIT |
The recent activity on the user's card has exceeded the total amount allowed by the issuer. |
CARD_ACTIVITY_EXCEEDS_COUNT_LIMIT |
The recent activity on the user's card has exceeded the number of transactions allowed by the issuer. |
CARD_AUTHENTICATION_FAILED |
The network specified that the card authentication failed. |
CARD_EXPIRATION_DATE_INVALID |
The expiration date on the card was invalid. |
CARD_EXPIRED |
The card has expired. |
CARD_LOST_OR_STOLEN |
The card has been lost or stolen. This includes 'Pickup' responses from the network. |
CARD_NOT_ACTIVATED |
The card has not been activated. Also referred to as ’Blocked, first used’. |
CARD_NUMBER_INVALID |
The card number is invalid. |
CARD_REQUIRES_RESERVE_CAPTURE |
This card does not support the Funds Transfer (single message) protocol. Instead use use the Reserve india-cards-v1.capture (dual message) service. |
CUSTOMER_INFO_INVALID |
The provided customer info is invalid. |
CVN_MISMATCH |
The transaction was declined because the CVN did not match. |
DO_NOT_HONOR |
The network returned "Do not honor". |
INSUFFICIENT_FUNDS |
Insufficient funds on the user's account. |
ISSUER_DECLINED |
The transaction was declined by the issuer. |
REVOCATION_OF_AUTHORIZATION |
The network returned "Revocation of authorization order". |
STOP_PAYMENT |
The network returned "stop payment". |
SUSPECTED_FRAUD |
The issuer suspects that this transaction is fraud. |
TRANSACTION_COULD_NOT_BE_ROUTED |
The Network could not route this transaction for processing. |
TRANSACTION_UNDER_AMOUNT_LIMIT |
Requested amount does not meet the minimum per-transaction amount. |
TRANSACTION_EXCEEDS_AMOUNT_LIMIT |
Requested amount exceeds the maximum per-transaction limit. |
TRANSACTION_INVALID |
The transaction is invalid. |
TRANSACTION_NOT_ALLOWED |
This transaction is not allowed in this context (e.g. country). |
TRANSACTION_PENDING |
The transaction is currently pending. This should not be treated as a successful payment. |
RECURRING_PAYMENT_NOT_SUPPORTED |
An attempt was made to charge for a recurring transaction, but it is not supported. |
NETWORK_TIMEOUT |
There was a timeout while attempting to process the card. |
RESTRICTED_CARD |
The card is restricted from making this type of purchase. |
CARD_AUTHENTICATION_EXPIRED |
The card authentication has expired. |
MANDATE_CREATION_FAILED |
The creation of the mandate failed. |
MANDATE_NOT_ACTIVE |
The specified mandate is not active to accept payments. |
MANDATE_REQUIRED_BUT_NOT_PRESENT |
A mandate is required for this transaction but one was not specified. |
CHARGE_CANCELED_BY_USER |
The user rejected this charge after receiving the notification for it. |
DUPLICATE_REQUEST |
This request is a duplicate of another. |
INTERNAL_ERROR |
An API processing error. |
INVALID_ISSUER_RESPONSE |
The issuer has given an invalid response. |
INVALID_REQUEST |
The card or request is invalid. |
ISSUER_UNAVAILABLE |
The issuer is unavailible. |
NOTIFICATION_NOT_SENT |
A notification was not sent to the user before a recurring mandate was used for payment. |
NOTIFICATION_NOT_VALID |
The notification that was sent to the user for a recurring mandate payment was invalid. |
NOT_PERMITTED |
The transaction is not permitted to the cardholder. |
CHARGE_NOT_APPROVED_BY_USER |
The charge has not been approved by the user. |
MANDATE_INSTRUMENT_NOT_VALID |
The instrument associated with the mandate on the integrator side is not valid. For example, when a mandate is created on card which is not migrated to a cloud token and deleted from the integrator's end. |
NETWORK_ALTID_FETCH_FAILED |
There was a failure when attempting to fetch the ALT ID for the card from the network. |
CardMetadata
Metadata about the card returned from the payment integrator that may be useful for future processing and debugging.
JSON representation |
---|
{
"issuerName": string,
"issuingCountryCode": string,
"networks": [
string
],
"cardType": enum ( |
Fields | |
---|---|
issuer |
OPTIONAL: The name of the card issuer. This is for internal use only and can take whatever format is most convenient for the payment integrator. It will not be displayed to the user and does not have to be human readable. |
issuing |
OPTIONAL: The country code of the country that this card was issued in using ISO-3166-1 Alpha-2 format. |
networks[] |
OPTIONAL: The networks that this card can be processed on. These should be in upper case. e.g. VISA, MASTERCARD, AMEX |
card |
REQUIRED: The type of card. |
CardType
The type of card.
Enums | |
---|---|
CARD_TYPE_UNSPECIFIED |
Do not ever set this default value! |
INTEGRATOR_CANNOT_SPECIFY_CARD_TYPE |
The payment integrator is not able to specify the Card Class. |
CREDIT_CARD |
This card is a CREDIT card |
DEBIT_CARD |
This card is a DEBIT card |
PREPAID_CARD |
This card is a PREPAID card |
RecurringMandateDetails
Details about the recurring mandate that was created.
JSON representation |
---|
{ "mandateId": string, "mandateStatus": enum ( |
Fields | |
---|---|
mandate |
** REQUIRED **: The ID that represents the mandate created for this recurring mandate. |
mandate |
** REQUIRED **: The current status of the mandate. |
mandate |
** REQUIRED **: Details pertaining to this mandate's creation. Set this when there is specific information that needs to be supplied regarding how the mandate was created. |
MandateStatus
The status of the mandate that was created.
Enums | |
---|---|
MANDATE_STATUS_UNSPECIFIED |
Do not ever set this default value! |
PENDING |
The mandate is initiated but awaiting confirmation. |
ACTIVE |
The mandate is active and can accept charges. |
REJECTED |
The mandate was rejected by the payment provider or issuer. |
DELETED |
The mandate was deleted by the customer or merchant. |
MandateCreationDetails
Details pertaining to mandate creation.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field source_of_mandate . ** REQUIRED **: Source of the payment-token on which the mandate was created. source_of_mandate can be only one of the following: |
|
integrator |
Signifies that the mandate was created on integrator's payment-token. |
google |
Signifies that the mandate was created on Google's payment-token. |