Method: disburseFundsResultNotification

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

La valeur disburseFundsResult est idempotente pour cet élément disburseFundsRequestId. Par conséquent, sa valeur doit être identique à celle 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 est de type ErrorResponse.

Les réponses à cette requête peuvent être vides si cette méthode ne renvoie pas de code HTTP 200. Le corps de la réponse est vide dans les cas où un ErrorResponse avec une description claire pourrait être utilisé pour aider un pirate informatique à comprendre l'identifiant de compte de l'intégrateur de paiement d'autres intégrateurs. Dans les cas où 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 a pu être vérifiée, des informations supplémentaires concernant l'erreur sont renvoyées dans le corps de la réponse.

Voici un exemple de requête:


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

Voici un 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)

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

string

OBLIGATOIRE: identifiant du compte de l'intégrateur de paiements sur lequel le paiement a été effectué.
disburseFundsRequestId

string

OBLIGATOIRE: Identifiant unique de cette transaction. Il s'agit du 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 d'une longueur maximale de 100 caractères qui ne contient que les caractères "a-z", "A-Z", "0-9", ":", "-" et "_".
disburseFundsResult

object (DisburseFundsResult)

OBLIGATOIRE: résultat de l'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)

OBLIGATOIRE: en-tête commun à toutes les réponses.
result

enum (DisburseFundsResultNotificationResultCode)

OBLIGATOIRE: 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)

OBLIGATOIRE: code de résultat de ce paiement.
rawResult

object (RawResult)

FACULTATIF: résultat brut de ce versement. Permet d'informer le moteur de risques et les analyses de Google. En cas de mise en correspondance de code de refus, des données sont parfois perdues. L'intégrateur peut choisir de fournir à Google un code brut. Par exemple, une passerelle de carte de crédit (l'intégrateur) peut utiliser ce champ pour communiquer à Google le code de refus exact envoyé par le réseau VISA. Dans ce cas, le scope correspond à "visa". et rawCode correspond à tout ce que renvoie le réseau VISA.

Cette valeur est obligatoire si 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 disburseFundsResultCode est DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT, il s'agit de la valeur de la transaction maximale autorisée. Elle est utilisée pour les messages structurés destinés aux utilisateurs et pour l'analyse du taux de refus.

Cette valeur correspond à micros du même currencyCode que l'appel de méthode disburseFunds d'origine.
transactionMinLimit

string (Int64Value format)

FACULTATIF: si disburseFundsResultCode est DISBURSEMENT_UNDER_TRANSACTION_LIMIT, il s'agit de la valeur de la transaction minimale autorisée. Elle est utilisée pour les messages structurés destinés aux utilisateurs et pour l'analyse du taux de refus.

Cette valeur correspond à micros du même currencyCode que l'appel de méthode disburseFunds d'origine.

DisburseFundsResultCode

Codes de résultat pour un appel de paiement.

Enums
UNKNOWN_RESULT Ne définissez jamais cette valeur par défaut.
SUCCESS Paiement réussi.
DISBURSEMENT_UNDER_TRANSACTION_LIMIT Le montant du versement demandé n'atteint pas le montant minimal par transaction défini par l'intégrateur. Si vous utilisez ce code, renseignez le champ transactionMinLimit avec le montant minimal de transaction pour diffuser des messages destinés aux utilisateurs.
DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT Le montant du versement demandé dépasse la limite maximale par transaction définie par l'intégrateur. Si vous utilisez ce code, renseignez le champ transactionMaxLimit avec la limite de transaction pour envoyer des messages destinés aux utilisateurs.
ACCOUNT_CLOSED Le compte de l'utilisateur détenu par l'intégrateur a été clôturé. Cette valeur renvoyée entraîne la fermeture de l'instrument de l'utilisateur auprès de Google. L'utilisateur sera obligé d'ajouter un nouvel instrument.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER Le compte de l'utilisateur associé à l'intégrateur a été clôturé. Le compte a probablement été piraté. Cette valeur renvoyée entraîne la fermeture de l'instrument de l'utilisateur auprès de Google. L'utilisateur sera obligé d'ajouter un nouvel instrument.
ACCOUNT_CLOSED_FRAUD Le compte de l'utilisateur détenu par l'intégrateur a été clôturé pour fraude. Cette valeur renvoyée entraîne la fermeture de l'instrument de l'utilisateur auprès de Google. L'utilisateur sera obligé d'ajouter un nouvel instrument.
ACCOUNT_ON_HOLD Le compte de l'utilisateur est suspendu.

RawResult

Objet résultat brut.

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

string

FACULTATIF: champ d'application du brutCode (peut être vide).
rawCode

string

OBLIGATOIRE: code brut de l'intégrateur ou de ses sous-systèmes.

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.