POST globalpayments/auth
Request Information
URI Parameters
None.
Body Parameters
GlobalPaymentsTokenRequestName | Description | Type | Additional information |
---|---|---|---|
captchaUserResponse | string |
None. |
|
constituent | Constituent |
None. |
|
sandbox | boolean |
None. |
|
CardStorageEnabled | boolean |
None. |
|
amount | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{ "sandbox": true, "CardStorageEnabled": true, "amount": 3.0, "captchaUserResponse": "sample string 1", "constituent": { "UserId": 1, "ConstituentId": 2, "SubEventId": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "Gender": "sample string 6", "Email": "sample string 7", "PhoneNumber": "sample string 8", "AddressLine1": "sample string 9", "AddressLine2": "sample string 10", "City": "sample string 11", "Province": "sample string 12", "ProvinceCode": "sample string 13", "CountryName": "sample string 14", "CountryCode": "sample string 15", "PostalCode": "sample string 16", "IsParticipant": true, "BirthDate": "sample string 18", "IsCaptain": true, "TeamId": 20, "UserGoal": 21.1, "RegistrationDate": "sample string 22", "UserLastModified": "sample string 23", "CustomField1": "sample string 24", "CustomField2": "sample string 25", "CustomField3": "sample string 26", "CustomField4": "sample string 27", "CustomField5": "sample string 28", "UserShareInfoOptOut": true, "Raised": 30.1, "TeamMembers": 31, "TeamName": "sample string 32", "TeamTotalRaised": 33.1, "TeamPersonalizedUrl": "sample string 34", "TeamImageUrl": "sample string 35", "SubEventGroupName": "sample string 36", "PersonalizedUrl": "sample string 37", "ImageUrl": "sample string 38", "shippingAddress": { "Address": "sample string 1", "PostalCode": "sample string 2", "City": "sample string 3", "Province": "sample string 4" }, "address": { "AddressType": "sample string 1", "Line1": "sample string 2", "Line2": "sample string 3", "City": "sample string 4", "RegionId": "sample string 5", "PostalCode": "sample string 6", "CountryId": "sample string 7" }, "IsCoCaptain": true, "CheckInId": "sample string 40", "reRegTxCode": "sample string 41", "PaymentMethod": "sample string 42", "inPersonCheckin": "sample string 43", "kitPickedUp": "sample string 44", "ItemName": "sample string 45", "CheckinInfo": { "checkinId": "055a3f74-7c98-4183-bb32-1a94bb711bb3", "registrationValues": [ { "CheckInId": "sample string 1", "Name": "sample string 2", "Value": "sample string 3" }, { "CheckInId": "sample string 1", "Name": "sample string 2", "Value": "sample string 3" } ], "transacStatus": "sample string 1", "insertDate": "2025-09-10T22:09:42.2672959-04:00", "registrationType": "sample string 3", "postData": "sample string 4" }, "PurchaseItems": [ { "ItemId": 1, "ItemName": "sample string 2", "Type": 3 }, { "ItemId": 1, "ItemName": "sample string 2", "Type": 3 } ] } }
application/xml, text/xml
Sample:
<GlobalPaymentsTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PmcfWebServices.Controllers"> <CardStorageEnabled>true</CardStorageEnabled> <amount>3</amount> <captchaUserResponse>sample string 1</captchaUserResponse> <constituent xmlns:d2p1="http://schemas.datacontract.org/2004/07/PmcfWebServices.Models"> <d2p1:AddressLine1>sample string 9</d2p1:AddressLine1> <d2p1:AddressLine2>sample string 10</d2p1:AddressLine2> <d2p1:BirthDate>sample string 18</d2p1:BirthDate> <d2p1:CheckInId>sample string 40</d2p1:CheckInId> <d2p1:CheckinInfo> <checkinId>055a3f74-7c98-4183-bb32-1a94bb711bb3</checkinId> <insertDate>2025-09-10T22:09:42.2672959-04:00</insertDate> <postData>sample string 4</postData> <registrationType>sample string 3</registrationType> <registrationValues> <d2p1:StringValue> <d2p1:CheckInId>sample string 1</d2p1:CheckInId> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:StringValue> <d2p1:StringValue> <d2p1:CheckInId>sample string 1</d2p1:CheckInId> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:StringValue> </registrationValues> <transacStatus>sample string 1</transacStatus> </d2p1:CheckinInfo> <d2p1:City>sample string 11</d2p1:City> <d2p1:ConstituentId>2</d2p1:ConstituentId> <d2p1:CountryCode>sample string 15</d2p1:CountryCode> <d2p1:CountryName>sample string 14</d2p1:CountryName> <d2p1:CustomField1>sample string 24</d2p1:CustomField1> <d2p1:CustomField2>sample string 25</d2p1:CustomField2> <d2p1:CustomField3>sample string 26</d2p1:CustomField3> <d2p1:CustomField4>sample string 27</d2p1:CustomField4> <d2p1:CustomField5>sample string 28</d2p1:CustomField5> <d2p1:Email>sample string 7</d2p1:Email> <d2p1:FirstName>sample string 4</d2p1:FirstName> <d2p1:Gender>sample string 6</d2p1:Gender> <d2p1:ImageUrl>sample string 38</d2p1:ImageUrl> <d2p1:IsCaptain>true</d2p1:IsCaptain> <d2p1:IsCoCaptain>true</d2p1:IsCoCaptain> <d2p1:IsParticipant>true</d2p1:IsParticipant> <d2p1:ItemName>sample string 45</d2p1:ItemName> <d2p1:LastName>sample string 5</d2p1:LastName> <d2p1:PaymentMethod>sample string 42</d2p1:PaymentMethod> <d2p1:PersonalizedUrl>sample string 37</d2p1:PersonalizedUrl> <d2p1:PhoneNumber>sample string 8</d2p1:PhoneNumber> <d2p1:PostalCode>sample string 16</d2p1:PostalCode> <d2p1:Province>sample string 12</d2p1:Province> <d2p1:ProvinceCode>sample string 13</d2p1:ProvinceCode> <d2p1:PurchaseItems> <d2p1:PurchaseItem> <d2p1:ItemId>1</d2p1:ItemId> <d2p1:ItemName>sample string 2</d2p1:ItemName> <d2p1:Type>3</d2p1:Type> </d2p1:PurchaseItem> <d2p1:PurchaseItem> <d2p1:ItemId>1</d2p1:ItemId> <d2p1:ItemName>sample string 2</d2p1:ItemName> <d2p1:Type>3</d2p1:Type> </d2p1:PurchaseItem> </d2p1:PurchaseItems> <d2p1:Raised>30.1</d2p1:Raised> <d2p1:RegistrationDate>sample string 22</d2p1:RegistrationDate> <d2p1:SubEventGroupName>sample string 36</d2p1:SubEventGroupName> <d2p1:SubEventId>3</d2p1:SubEventId> <d2p1:TeamId>20</d2p1:TeamId> <d2p1:TeamImageUrl>sample string 35</d2p1:TeamImageUrl> <d2p1:TeamMembers>31</d2p1:TeamMembers> <d2p1:TeamName>sample string 32</d2p1:TeamName> <d2p1:TeamPersonalizedUrl>sample string 34</d2p1:TeamPersonalizedUrl> <d2p1:TeamTotalRaised>33.1</d2p1:TeamTotalRaised> <d2p1:UserGoal>21.1</d2p1:UserGoal> <d2p1:UserId>1</d2p1:UserId> <d2p1:UserLastModified>sample string 23</d2p1:UserLastModified> <d2p1:UserShareInfoOptOut>true</d2p1:UserShareInfoOptOut> <d2p1:address> <d2p1:AddressType>sample string 1</d2p1:AddressType> <d2p1:City>sample string 4</d2p1:City> <d2p1:CountryId>sample string 7</d2p1:CountryId> <d2p1:Line1>sample string 2</d2p1:Line1> <d2p1:Line2>sample string 3</d2p1:Line2> <d2p1:PostalCode>sample string 6</d2p1:PostalCode> <d2p1:RegionId>sample string 5</d2p1:RegionId> </d2p1:address> <d2p1:inPersonCheckin>sample string 43</d2p1:inPersonCheckin> <d2p1:kitPickedUp>sample string 44</d2p1:kitPickedUp> <d2p1:reRegTxCode>sample string 41</d2p1:reRegTxCode> <d2p1:shippingAddress> <d2p1:Address>sample string 1</d2p1:Address> <d2p1:City>sample string 3</d2p1:City> <d2p1:PostalCode>sample string 2</d2p1:PostalCode> <d2p1:Province>sample string 4</d2p1:Province> </d2p1:shippingAddress> </constituent> <sandbox>true</sandbox> </GlobalPaymentsTokenRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponseName | Description | Type | Additional information |
---|---|---|---|
status | string |
None. |
|
message | string |
None. |
|
fullErr | string |
None. |
|
objResponse | Object |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.