Method: disburseFundsResultNotification

Informer Google du résultat du versement une fois l'appel de méthode disburseFunds effectué.

La valeur disburseFundsResult étant idempotente pour ce disburseFundsRequestId, elle doit être identique à la valeur renvoyée lors de l'appel disburseFunds et ne peut pas être modifiée par un appel ultérieur à cette méthode.

Si le point de terminaison rencontre une erreur lors du traitement de la requête, sa réponse sera de type ErrorResponse.

Les réponses à cette requête peuvent être vides si cette méthode ne renvoie pas de réponse HTTP 200. Le corps de la réponse est vide dans les situations où un élément ErrorResponse avec une description claire pourrait être utilisé pour aider un pirate informatique à comprendre l'identifiant de compte d'intégrateur de paiement d'autres intégrateurs. Dans ces situations, lorsque la clé de signature ne correspond pas, l'identifiant de l'intégrateur de paiement est introuvable ou la clé de chiffrement est inconnue, cette méthode renvoie une erreur HTTP 404 avec un corps vide. Si la signature de la requête peut être validée, des informations supplémentaires sur l'erreur seront renvoyées dans le corps de la réponse.

Exemple de requête:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "KcgwSKrV76eVNDUbsZ4UA3",
    "requestTimestamp": "1481852928293"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "disburseFundsRequestId": "awNaC510cefae3IJdNEvW2",
  "disburseFundsResult": {
    "disburseFundsResultCode": "SUCCESS"
  }
}

Exemple de réponse:


{
  "responseHeader": {
    "responseTimestamp": "1481852928324"
  },
  "result": "SUCCESS"
}

Requête HTTP :

POST https://vgw.googleapis.com/secure-serving/gsp/v1/disburseFundsResultNotification/:PIAID

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "disburseFundsRequestId": string,
  "disburseFundsResult": {
    object (DisburseFundsResult)
  }
}
Champs
requestHeader

object (RequestHeader)

REQUIRED: en-tête commun à toutes les requêtes.

paymentIntegratorAccountId

string

OBLIGATOIRE: identifiant de compte d'intégrateur de paiement sur lequel le versement a été effectué.

disburseFundsRequestId

string

REQUIRED: identifiant unique pour cette transaction. Il s'agit de l'requestId généré par Google lors de l'appel disburseFunds auquel cette requête est associée.

Il s'agit d'une chaîne de 100 caractères au maximum, qui ne contient que les caractères "a-z", "A-Z", "0-9", "":"", "-" et "_".

disburseFundsResult

object (DisburseFundsResult)

REQUIRED: résultat de cet appel de paiement.

Corps de la réponse

Objet de réponse pour la méthode disburseFundsResultNotification.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": enum (DisburseFundsResultNotificationResultCode)
}
Champs
responseHeader

object (ResponseHeader)

REQUIRED: en-tête commun pour toutes les réponses.

result

enum (DisburseFundsResultNotificationResultCode)

REQUIRED: résultat de cet appel.

DisburseFundsResult

Informations sur le résultat final d'un paiement.

Représentation JSON
{
  "disburseFundsResultCode": enum (DisburseFundsResultCode),
  "rawResult": {
    object (RawResult)
  },

  // Union field FailureDetail can be only one of the following:
  "transactionMaxLimit": string,
  "transactionMinLimit": string
  // End of list of possible types for union field FailureDetail.
}
Champs
disburseFundsResultCode

enum (DisburseFundsResultCode)

REQUIRED: code de résultat de ce versement.

rawResult

object (RawResult)

FACULTATIF: Résultat brut de ce versement. Permet de guider le moteur de gestion des risques et les analyses de Google. Dans les situations de mappage de code refusé, les données sont parfois perdues. L'intégrateur peut choisir de donner à Google un code brut. Par exemple, une passerelle de carte de crédit (l'intégrateur) peut utiliser ce champ pour indiquer à Google le code de refus exact reçu par le réseau VISA. Dans ce cas, le scope serait "visa" et le rawCode correspondrait à ce que le réseau VISA renvoyait.

Cette valeur est obligatoire si l'élément result n'est pas SUCCESS.

Champ d'union FailureDetail.

FailureDetail ne peut être qu'un des éléments suivants :

transactionMaxLimit

string (Int64Value format)

FACULTATIF: si la valeur de disburseFundsResultCode est DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT, il s'agit de la valeur de la transaction maximale autorisée. Il est utilisé pour envoyer des messages structurés aux utilisateurs et analyser le taux de refus.

Cette quantité est de micros du même currencyCode que l'appel de méthode disburseFunds d'origine.

transactionMinLimit

string (Int64Value format)

FACULTATIF: si la valeur de disburseFundsResultCode est DISBURSEMENT_UNDER_TRANSACTION_LIMIT, il s'agit de la valeur de la transaction minimale autorisée. Il est utilisé pour envoyer des messages structurés aux utilisateurs et analyser le taux de refus.

Cette quantité est de micros du même currencyCode que l'appel de méthode disburseFunds d'origine.

DisburseFundsResultCode

Codes de résultat pour un appel "fonds de paiement".

Enums
UNKNOWN_RESULT Ne définissez jamais cette valeur par défaut.
SUCCESS Le versement a bien été effectué.
DISBURSEMENT_UNDER_TRANSACTION_LIMIT Le montant du versement demandé n'atteint pas le montant minimal par intégrateur de chaque transaction. Si ce code est utilisé, renseignez le champ transactionMinLimit en indiquant le montant minimal de transaction pour les messages destinés aux utilisateurs.
DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT Le montant du paiement demandé dépasse la limite maximale par transaction de l'intégrateur. Si ce code est utilisé, renseignez le champ transactionMaxLimit avec la limite de transaction pour les messages destinés aux utilisateurs.
ACCOUNT_CLOSED Le compte de l'utilisateur associé à l'intégrateur a été clôturé. Cette valeur renvoyée entraînera la fermeture de l'instrument de l'utilisateur avec Google. L'utilisateur devra ajouter un nouvel instrument.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER Le compte de l'utilisateur associé à l'intégrateur a été clôturé. Il risque d'être piraté. Cette valeur renvoyée entraînera la fermeture de l'instrument de l'utilisateur avec Google. L'utilisateur devra ajouter un nouvel instrument.
ACCOUNT_CLOSED_FRAUD Le compte de l'utilisateur soumis à l'intégrateur a été clôturé pour cause de fraude. Cette valeur renvoyée entraînera la fermeture de l'instrument de l'utilisateur avec Google. L'utilisateur devra ajouter un nouvel instrument.
ACCOUNT_ON_HOLD Le compte de l'utilisateur est bloqué.

Résultat brut

Objet de résultat brut.

Représentation JSON
{
  "scope": string,
  "rawCode": string
}
Champs
scope

string

FACULTATIF: le champ d'application du code brut peut être vide.

rawCode

string

REQUIRED: code brut de l'intégrateur ou des sous-systèmes qu'il contient.

DisburseFundsResultNotificationResultCode

Codes de résultat pour la méthode disburseFundsResultNotification

Enums
UNKNOWN_RESULT Ne définissez jamais cette valeur par défaut.
SUCCESS La notification a bien été traitée.